Skip to content

CLI Commands Reference

Reference for all available ruseon-cli commands.


Global Authentication & Flags

All commands support the following flags or environment variables:

  • --api <url>: REST API endpoint (default: http://127.0.0.1:8080/api).
  • -u, --user <username>: Admin/Operator username (or RUSEON_USER env).
  • -p, --pass <password>: Admin/Operator password (or RUSEON_PASS env).

status

Displays overall system health, runtime memory, camera counts, and active connections.

bash
ruseon-cli status

Example Output:

text
=== RUSEON Core Status ===
Uptime:           24h 12m 30s
Memory (Heap):    1.21 GB
Goroutines:       1539
Total Cameras:    100
Online Cameras:   95
Disabled Cameras: 5
Active Clients:   180

cameras Group

cameras list

Outputs a formatted table of all registered cameras.

bash
ruseon-cli cameras list

Columns: ID, STATE, RECORD, UPTIME, CODEC, BITRATE, URL

cameras add

Register a new camera and start streaming.

bash
ruseon-cli cameras add --id cam-03 --url rtsp://192.168.1.103:554/stream1 --record
  • --id (string, required): Unique camera identifier.
  • --url (string, required): RTSP stream URL.
  • --record (bool, optional): Enable continuous fMP4 recording.

cameras delete

Stop the stream and delete the camera from BadgerDB.

bash
ruseon-cli cameras delete --id cam-03
  • --id (string, required): Camera ID to delete.

users Group

Manage system users and RBAC roles stored in BadgerDB.

users list

Displays a table of registered users and their RBAC roles.

bash
ruseon-cli users list

users add

Create a new user account.

bash
ruseon-cli users add --username operator1 --password "SecretPass123!" --role operator
  • --username (string, required): New username.
  • --password (string, required): Password.
  • --role (string, required): Role (admin, operator, viewer, service).

users edit

Update credentials or modify role.

bash
ruseon-cli users edit --username operator1 --password "NewPass456!" --role admin

users delete

Delete a user account (default admin cannot be deleted).

bash
ruseon-cli users delete --username operator1

Released under the MIT License.