Skip to content

Command Line Interface (ruseon-cli) Overview ​

ruseon-cli (cmd/ruseon-cli/main.go) is a standalone CLI administration and automation tool built with Go and spf13/cobra. It allows DevOps engineers and automated scripts to manage cameras, inspect server health, and manage RBAC users via the RUSEON Core REST API.


1. Global Flags & Connection Parameters ​

All ruseon-cli commands support standard global flags for connecting to local or remote RUSEON instances:

FlagShorthandEnvironment VariableDefault ValueDescription
--api—RUSEON_API_URLhttp://127.0.0.1:8080/apiBase URL of the RUSEON Core REST API
--user-uRUSEON_USERadminAdministrator username for JWT login
--pass-pRUSEON_PASS""Administrator password

2. Supported Command Structure ​

  • ruseon-cli status: Queries GET /api/stats and displays active cameras, uptime, frame rate, and system memory.
  • ruseon-cli cameras: Subcommands to list, register, and delete camera streams:
    • ruseon-cli cameras list
    • ruseon-cli cameras add --id <id> --url <rtsp_url> [--record]
    • ruseon-cli cameras delete --id <id>
  • ruseon-cli users: Subcommands to manage system users and RBAC roles:
    • ruseon-cli users list
    • ruseon-cli users add --username <u> --password <p> --role <r>
    • ruseon-cli users edit --username <u> [--password <p>] [--role <r>]
    • ruseon-cli users delete --username <u>

3. Quick Usage Examples ​

bash
# Check server status
ruseon-cli status --pass "myAdminPassword123"

# Add a new camera
ruseon-cli cameras add --id "front-gate" --url "rtsp://admin:pass@192.168.1.100:554/live" --record

# List all configured cameras
ruseon-cli cameras list

# Create a new operator user
ruseon-cli users add --username "operator1" --password "SecurePass456" --role "operator"

Released under the MIT License.