Skip to content

Complete CLI Commands Reference (ruseon-cli) ​

ruseon-cli provides dedicated subcommands for server monitoring, camera stream provisioning, and RBAC user management.


1. System Status & Diagnostics ​

ruseon-cli status ​

Queries GET /api/stats and outputs server uptime, memory allocations, total active streams, and aggregate ingestion FPS:

bash
ruseon-cli status --pass "adminSecret"

2. Camera Management Commands ​

ruseon-cli cameras list ​

List all registered cameras, their RTSP URLs, and recording flags:

bash
ruseon-cli cameras list

ruseon-cli cameras add ​

Add and start a new RTSP camera stream:

bash
ruseon-cli cameras add \
  --id "cam-entrance" \
  --url "rtsp://admin:pass@192.168.1.100:554/live" \
  --record
  • --id (string, required): Unique identifier for the camera.
  • --url (string, required): RTSP source URL.
  • --record (boolean, optional, default true): Enable continuous fMP4 archive recording.

ruseon-cli cameras delete ​

Delete a camera stream from the system:

bash
ruseon-cli cameras delete --id "cam-entrance"

3. User & RBAC Management Commands ​

ruseon-cli users list ​

List all system users and their assigned RBAC roles:

bash
ruseon-cli users list

ruseon-cli users add ​

Create a new user account:

bash
ruseon-cli users add \
  --username "operator_john" \
  --password "SecurePassword123" \
  --role "operator"
  • --username (string, required): Unique user login name.
  • --password (string, required): User password (hashed with bcrypt on the server).
  • --role (string, required): Assigned role (admin, operator, viewer, service).

ruseon-cli users edit ​

Update an existing user's password or RBAC role:

bash
ruseon-cli users edit \
  --username "operator_john" \
  --role "viewer"

ruseon-cli users delete ​

Delete a user account:

bash
ruseon-cli users delete --username "operator_john"

Released under the MIT License.