Documentation Index
Fetch the complete documentation index at: https://docs.roboticks.io/llms.txt
Use this file to discover all available pages before exploring further.
Commands Reference
Complete reference for all rbtk commands organized by category.
Output Formats
All list commands support multiple output formats:
rbtk device list # Default table format
rbtk device list --output json # JSON output
rbtk device list --output yaml # YAML output
rbtk device list --output ids # Just IDs (for piping)
Authentication Commands
rbtk login
Login via browser authentication.
rbtk logout
Clear stored credentials.
rbtk auth status
Check current authentication status.
Context Commands
rbtk context
Show current organization and project context.
rbtk context set
Set the current context.
rbtk context set --org acme --project warehouse
rbtk context list
List available organizations and projects.
rbtk context clear
Clear saved context.
Organization Commands
rbtk org list
List organizations you have access to.
rbtk org get
Get organization details.
rbtk org get # Current org
rbtk org get acme # Specific org by slug
rbtk org limits
Show organization usage limits and current usage.
Project Commands
rbtk project list
List projects in the current organization.
rbtk project get
Get project details.
rbtk project get # Current project
rbtk project get warehouse # Specific project by slug
Device Commands
rbtk device list
List devices in the current project.
rbtk device list
rbtk device list --status online
rbtk device list --type robot
rbtk device list --group 5
| Flag | Description |
|---|
--status | Filter by status (online, offline, maintenance) |
--type | Filter by device type |
--group | Filter by device group ID |
--limit | Maximum number of results |
rbtk device get
Get device details.
Capsule Commands
Capsules are software packages (tarballs) uploaded to Roboticks.
rbtk capsule list
List capsules in the current project.
rbtk capsule list
rbtk capsule list --name perception
rbtk capsule push
Upload a new capsule.
rbtk capsule push ./build.tar.gz --name perception --version 2.1.0
rbtk capsule push ./app.tar.gz --name app --version 1.0.0 --type sw
| Flag | Description | Required |
|---|
--name | Capsule name | Yes |
--version | Version string | Yes |
--type | Capsule type (sw, config) | No |
--description | Description | No |
rbtk capsule get
Get capsule details.
rbtk capsule pull
Download capsule archive.
rbtk capsule pull 123
rbtk capsule pull 123 -o ./downloads/
rbtk capsule delete
Delete a capsule.
Test Package Commands
rbtk test-package list
List test packages.
rbtk test-package push
Upload a test package.
rbtk test-package push ./tests.tar.gz --name suite --version 1.0.0
rbtk test-package get
Get test package details.
rbtk test-package get 123
Package Commands
Packages combine a capsule with a configuration for deployment.
rbtk package list
List packages.
rbtk package create
Create a new package.
rbtk package create --name prod-v1.0 --capsule 5 --config 3
| Flag | Description | Required |
|---|
--name | Package name | Yes |
--capsule | Capsule ID | Yes |
--config | Configuration ID | No |
rbtk package get
Get package details.
rbtk package activate
Activate a package (make it deployable).
rbtk package activate 123
rbtk package deactivate
Deactivate a package.
rbtk package deactivate 123
rbtk package set-latest
Mark package as the latest version.
rbtk package set-latest 123
Configuration Commands
rbtk config list
List configurations.
rbtk config create
Create a new configuration.
rbtk config create --name production
rbtk config set
Set configuration variables.
rbtk config set production API_URL=https://api.prod.io
rbtk config set production DEBUG=false LOG_LEVEL=info
rbtk config get
Get configuration with variables.
rbtk config get production
rbtk config push
Upload a configuration file.
rbtk config push ./config.yaml --name prod-config --version 1.0.0 --capsule-id 123
Device Group Commands
rbtk group list
List device groups.
rbtk group create
Create a device group.
rbtk group create --name "Production"
rbtk group get
Get group details with devices.
rbtk group update
Update a group.
rbtk group update 5 --name "Staging"
rbtk group delete
Delete a group.
rbtk group devices
Manage devices in a group.
rbtk group devices list 5 # List devices in group
rbtk group devices add 5 123 124 # Add devices to group
rbtk group devices remove 5 123 # Remove device from group
Rollout Commands
Rollouts deploy packages to device groups.
rbtk rollout list
List rollouts.
rbtk rollout create
Create a new rollout.
rbtk rollout create --package 10 --group 5
rbtk rollout create --package 10 --group 5 --start # Create and start immediately
rbtk rollout get
Get rollout details.
rbtk rollout start
Start a draft rollout.
rbtk rollout pause
Pause a running rollout.
rbtk rollout resume
Resume a paused rollout.
rbtk rollout cancel
Cancel a rollout.
rbtk rollout watch
Watch rollout progress in real-time.
rbtk rollout groups
List device groups available for rollouts.
Simulation (Test Jobs) Commands
rbtk simulate list
List test jobs.
rbtk simulate run
Run a new test job on cloud runners.
rbtk simulate run --fleet 1 --test 5
rbtk simulate run --fleet 1 --test 5 --watch # Run and watch progress
rbtk simulate get
Get test job details.
rbtk simulate watch
Watch test job progress.
rbtk simulate rerun
Rerun a completed test job.
rbtk simulate cancel
Cancel a running test job.
rbtk simulate fleets
List available runner fleets.
rbtk simulate test-packages
List test packages for simulation.
rbtk simulate test-packages
Session Commands
rbtk session list
List sessions.
rbtk session list
rbtk session list --device 123
rbtk session list --status completed
rbtk session list --since 24h
rbtk session get
Get session details.
rbtk session delete
Delete a session and its artifacts.
rbtk session tag
Manage session tags.
rbtk session tag add 456 important
rbtk session tag remove 456 old
rbtk session files
Manage session files.
rbtk session files list 456
rbtk session files download 456 logs/main.log
rbtk session files download-all 456 -o ./session-files/
Log Commands
rbtk log list
View device logs.
rbtk log list --device 123
rbtk log list --level error --since 24h
rbtk log list --search "connection failed"
| Flag | Description |
|---|
--device | Filter by device ID |
--session | Filter by session ID |
--level | Filter by log level (debug, info, warn, error) |
--since | Time range (e.g., 1h, 24h, 7d) |
--search | Text search in log messages |
--limit | Maximum number of logs |
rbtk log stream
Stream logs in real-time.
rbtk log stream --device 123
rbtk log stream --session 456 --level error
rbtk log export
Export logs to file.
rbtk log export --device 123 --since 24h -o logs.json
rbtk log export --device 123 --format csv -o logs.csv
Tunnel Commands
rbtk tunnel list
List active tunnels.
rbtk tunnel ssh
SSH into a device (auto-creates tunnel if needed).
rbtk tunnel create
Create a tunnel manually.
rbtk tunnel create 123 --duration 2h
rbtk tunnel close
Close an active tunnel.
Environment Variable Commands
rbtk env list
List environment variables.
rbtk env list
rbtk env list --show-values # Show non-secret values
rbtk env get
Get a specific variable.
rbtk env set
Set an environment variable.
rbtk env set API_URL https://api.example.com
rbtk env set API_KEY secret123 --secret # Mark as secret
rbtk env delete
Delete a variable.
rbtk env import
Import from a file.
rbtk env export
Export to a file.
Composition Commands
Compositions are Docker images uploaded to Roboticks.
rbtk composition list
List compositions.
rbtk composition push
Push a Docker image.
rbtk composition push my-app:latest --name my-app --version 1.0.0
rbtk composition get
Get composition details.
rbtk composition pull
Pull image to local Docker.
rbtk composition pull 123
rbtk composition delete
Delete a composition.
rbtk composition delete 123
rbtk composition ecr-login
Get container registry credentials for Docker login.
rbtk composition ecr-login
Device Manager Commands
rbtk device-manager list
List available device manager versions.
rbtk device-manager list
rbtk device-manager list --os linux --arch arm64
rbtk device-manager get
Get version details.
rbtk device-manager get 5
rbtk device-manager download
Download a specific version.
rbtk device-manager download 5 -o ./roboticks-dm
rbtk device-manager latest
Download the latest version for your platform.
rbtk device-manager latest --os linux --arch arm64
