Skip to content

device

Terminal window
snippbot device list # List all devices
snippbot device list --status active # Filter by status
snippbot device info <id> # Show device details
snippbot device revoke <id> # Revoke auth token
snippbot device block <id> # Block device
snippbot device delete <id> # Delete device record
snippbot device exec <id> <tool> [args] # Execute tool on device

List all registered devices.

Terminal window
snippbot device list
snippbot device list --status active
snippbot device list --json
OptionValuesDescription
--statuspending, active, blocked, revokedFilter by status
--jsonJSON output

Show details for a specific device.

Terminal window
snippbot device info DEVICE_ID

Displays: ID, name, platform, architecture, status, agent version, paired timestamp, last seen, online status, and capabilities.


Revoke a device’s authentication token. The device will need to re-pair to reconnect.

Terminal window
snippbot device revoke DEVICE_ID

Prompts for confirmation before executing.


Block a device from connecting even if it has a valid token.

Terminal window
snippbot device block DEVICE_ID

Permanently delete a device record from the database.

Terminal window
snippbot device delete DEVICE_ID

Prompts for confirmation before executing.


Execute a tool on a remote device.

Terminal window
snippbot device exec DEVICE_ID bash -a command="ls -la"
snippbot device exec DEVICE_ID system_info
snippbot device exec DEVICE_ID read_file -a path="/etc/hostname"
snippbot device exec DEVICE_ID bash -a command="uptime" --timeout 60 --json
OptionDefaultDescription
-a, --argTool argument as key=value (repeatable)
--timeout300Execution timeout in seconds
--jsonJSON output

Available tools depend on device capabilities. Common tools:

ToolDescription
bashRun a shell command
system_infoReturn OS, CPU, memory stats
read_fileRead a file
write_fileWrite a file
list_filesList directory contents

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.