Skip to main content

​
Roboticks CLI

rbtk is the command-line driver for the Roboticks platform. Use it to upload requirements, kick off test runs, stream logs, pull evidence packs, and operate runner pools. The dashboard is the friendliest surface for most of this; the CLI is the one you script. The package ships two binary names so you can pick the one that reads best in your scripts:
  • rbtk — short, fast to type
  • roboticks — clear, self-documenting
They’re identical entry points. Use either.

​
Why a CLI in addition to the dashboard

JobDashboardCLI
Eyeballing a traceability matrixBestPossible (rbtk requirements coverage)
Uploading a 4000-line ReqIF on every releasePainfulrbtk requirements upload in CI
Pulling the latest evidence pack into an audit folderClick-and-downloadrbtk test evidence-pack <run-id> --out ./audit/
Running a one-off test against a feature branchPossiblerbtk test run --push ./
Diagnosing a runner pool from the airline loungeNorbtk pool runners --pool prod-gpu-farm
If you’re scripting against the platform, the CLI is the supported surface — the underlying REST API is versioned but not contract-stable across point releases.

​
Command-group map

rbtk
├── auth            # login, logout, status, GitHub OIDC exchange
├── context         # current org/project selection
├── test            # run, list, results, logs, artifacts, evidence-pack
├── requirements    # upload, list, show, coverage, export
├── github          # link a repo, check link status, unlink
├── pool            # list, create, register-runner, runners, delete
├── log             # stream test-run logs
├── org             # list, get
└── project         # list, get
Each group has its own deep-dive page. The full reference index is at Commands.

​
Quickstart

# 1. Install
pipx install roboticks-cli

# 2. Authenticate
rbtk auth login                       # opens a browser

# 3. Pick a context
rbtk context set --org acme --project warehouse

# 4. Upload a requirement and run a test
rbtk requirements upload ./roboticks/requirements.yaml
rbtk test run --push ./

# 5. Pull the evidence pack
rbtk test evidence-pack latest --out ./evidence/

​
Three auth modes

ModeUse caseHow
OAuth + keyringLocal developmentrbtk auth login
API key (ROBOTICKS_API_KEY)Generic CI, scriptsMint in dashboard, export env var
GitHub OIDCGitHub Actionsrbtk auth oidc-from-github
See Authentication for the matrix.

​
Output formats

All commands accept --output table|json|yaml. The default is table (pretty) for TTY, json for non-TTY. Pipe-friendly aliases like --output ids are available on list commands. 
rbtk test list --output json | jq '.[0].id'
rbtk test list --output ids
rbtk requirements list --output yaml > backup.yaml
See Output formats for the full spec, including the sparkline column for last-N test runs.

​
CI-friendly defaults

The CLI auto-detects non-TTY environments and:
  • Disables progress bars and colour
  • Returns non-zero exit codes on failure
  • Refuses interactive prompts (set ROBOTICKS_INTERACTIVE=true to override)
  • Emits JSON unless you ask for table
# Force CI behaviour locally
ROBOTICKS_CI=true rbtk test run --push ./

​
Where to go next

Install

pip, pipx, or Homebrew. Python 3.10+.

Authenticate

OAuth, API keys, GitHub OIDC.

Test commands

The most-used group. Run, list, results, logs, evidence-pack.

CI/CD recipes

GitHub Actions, GitLab CI, Jenkins, CircleCI, BuildKite.