Skip to main content

​
Commands

rbtk organises commands into groups. This page is the index; each group has its own deep-dive page with full flag tables and examples. Run rbtk --help for a live tree, or rbtk <group> --help to drill in.

​
Global flags

These flags work on every command.
FlagDefaultDescription
--output table|json|yamltable (TTY), json (non-TTY)Output format. See Output formats.
--project <slug>from contextOverride the project for this invocation.
--org <slug>from contextOverride the org for this invocation.
--api-key <key>from env / keyringOverride the API key for this invocation.
--debugoffPrint HTTP requests, response status, and timing.
--quietoffSuppress progress and informational lines.
--no-coloroffDisable ANSI colour output.

​
Command groups

GroupWhat it doesDeep dive
rbtk authLog in/out, status, GitHub OIDC exchange, API key managementContext & auth commands
rbtk contextSwitch the active org and project; show current selectionContext & auth commands
rbtk testRun tests, watch live progress, inspect cases, fetch logs / files / evidence packsTest commands
rbtk requirementsUpload, list, show requirements; export and coverage reportsRequirements commands
rbtk githubLink/unlink repos, show GitHub App statusGitHub commands
rbtk poolList, create, delete pools; register runners; per-pool statsPool commands
rbtk logStream test-run logs in real timeTest commands → logs
rbtk orgList, get orgs you can accesscovered in Context & auth
rbtk projectList, get projects in the current orgcovered in Context & auth

​
Recipes by intent

GoalCommand
Run my repo’s tests oncerbtk test run --push ./
Run on hosted Gazebo GPUrbtk test cloud --pool hosted-gazebo-gpu --push ./
Watch a queued run go liverbtk test watch <run-id>
List test cases that ranrbtk test cases <run-id>
Download a single test’s artifactsrbtk test files <run-id> --nodeid "tests/test_x.py::test_y" --download --out ./test_y/
Pull the latest evidence packrbtk test evidence-pack latest --out ./evidence/
Upload a ReqIF filerbtk requirements upload reqs.reqif
See which requirements are uncoveredrbtk requirements coverage --filter uncovered
Tail logs of a running testrbtk log <run-id>
Create a self-hosted poolrbtk pool create --name gpu-prod --type self-hosted
Mint a runner registration tokenrbtk pool register-runner --pool gpu-prod
Switch projectrbtk context set --project warehouse

​
Exit codes

CodeMeaning
0Success
1Generic failure (logic error, API error)
2Bad CLI invocation (unknown flag, missing arg)
3Authentication failure
4Authorization failure (wrong scope, no access)
5Resource not found
6Validation failure (e.g., ReqIF malformed)
7Test run finished but failed (rbtk test run etc.)
8Pool / runner offline or unavailable
Use these in shell scripts: 
rbtk test run --push ./ --wait || exit_code=$?
case $exit_code in
  0) echo "PASS" ;;
  7) echo "Tests failed"; exit 1 ;;
  *) echo "Infrastructure error ($exit_code)"; exit 2 ;;
esac

​
Where to go next

Test commands

The largest group — run, list, results, logs, artifacts.

Requirements

Upload, coverage, export.

Pool commands

Operate runner pools from the CLI.

Output formats

JSON, YAML, sparkline tables, ID-only piping.