device
Overview
Section titled “Overview”snippbot device list # List all devicessnippbot device list --status active # Filter by statussnippbot device info <id> # Show device detailssnippbot device revoke <id> # Revoke auth tokensnippbot device block <id> # Block devicesnippbot device delete <id> # Delete device recordsnippbot device exec <id> <tool> [args] # Execute tool on devicesnippbot device list
Section titled “snippbot device list”List all registered devices.
snippbot device listsnippbot device list --status activesnippbot device list --json| Option | Values | Description |
|---|---|---|
--status | pending, active, blocked, revoked | Filter by status |
--json | JSON output |
snippbot device info
Section titled “snippbot device info”Show details for a specific device.
snippbot device info DEVICE_IDDisplays: ID, name, platform, architecture, status, agent version, paired timestamp, last seen, online status, and capabilities.
snippbot device revoke
Section titled “snippbot device revoke”Revoke a device’s authentication token. The device will need to re-pair to reconnect.
snippbot device revoke DEVICE_IDPrompts for confirmation before executing.
snippbot device block
Section titled “snippbot device block”Block a device from connecting even if it has a valid token.
snippbot device block DEVICE_IDsnippbot device delete
Section titled “snippbot device delete”Permanently delete a device record from the database.
snippbot device delete DEVICE_IDPrompts for confirmation before executing.
snippbot device exec
Section titled “snippbot device exec”Execute a tool on a remote device.
snippbot device exec DEVICE_ID bash -a command="ls -la"snippbot device exec DEVICE_ID system_infosnippbot device exec DEVICE_ID read_file -a path="/etc/hostname"snippbot device exec DEVICE_ID bash -a command="uptime" --timeout 60 --json| Option | Default | Description |
|---|---|---|
-a, --arg | Tool argument as key=value (repeatable) | |
--timeout | 300 | Execution timeout in seconds |
--json | JSON output |
Available tools depend on device capabilities. Common tools:
| Tool | Description |
|---|---|
bash | Run a shell command |
system_info | Return OS, CPU, memory stats |
read_file | Read a file |
write_file | Write a file |
list_files | List directory contents |
Pairing devices
Section titled “Pairing devices”To pair a new device (e.g., a phone or another machine), open Settings → Devices in the web UI and scan the QR code. The device generates a TOTP-based pairing token that establishes a secure WebSocket connection.
See Devices UI guide for step-by-step instructions.