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

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

Each group has its own deep-dive page. The full reference index is at Commands.

​
Quickstart

​
Three auth modes

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.
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

​
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.