Install the CLI The CLI is the Python package roboticks-cli published to PyPI , sources at github.com/roboticks-io/roboticks-cli . It installs two console scripts : rbtk and roboticks. Use whichever you prefer — they’re the same entry point.
Requirements Python 3.10 or newer. Check with python3 --version.
A POSIX shell or Windows PowerShell.
Install pipx (recommended)
pip
Homebrew (macOS / Linux)
From source
pipx installs the CLI into a dedicated virtualenv so it cannot collide with project Python deps.# If you don't have pipx python3 -m pip install --user pipx python3 -m pipx ensurepath # Install pipx install roboticks-cli
Upgrade: pipx upgrade roboticks-cli
pip install --user roboticks-cli
Use pip install roboticks-cli (no --user) inside a virtualenv. Avoid system-wide installs on managed Python — pipx is the better path. Upgrade: pip install --user --upgrade roboticks-cli
brew install roboticks-io/tap/rbtk
The Homebrew formula installs rbtk only; if you want the roboticks alias, symlink it: ln -s "$( brew --prefix )/bin/rbtk" "$( brew --prefix )/bin/roboticks"
Upgrade: For SDK contributors: git clone https://github.com/roboticks-io/roboticks-cli.git cd roboticks-cli pip install -e ".[dev]" pytest
Verify rbtk --version # rbtk 1.4.0 (commit a1b2c3, py3.12.4, darwin/arm64) # Same binary under the other name roboticks --help
Shell completion Tab completion is supported for Bash, Zsh, Fish, and PowerShell. Install once:
rbtk completion bash | sudo tee /etc/bash_completion.d/rbtk > /dev/null
mkdir -p ~/.zsh/completions rbtk completion zsh > ~/.zsh/completions/_rbtk # Ensure ~/.zsh/completions is on your $fpath
rbtk completion fish > ~/.config/fish/completions/rbtk.fish
rbtk completion powershell | Out-String | Invoke-Expression # Persist by appending the above to $PROFILE
Restart the shell. Completion covers commands, options, and dynamic values (project slugs, pool names, run IDs) when authenticated.
Uninstall # pipx pipx uninstall roboticks-cli # pip pip uninstall roboticks-cli # Homebrew brew uninstall rbtk
The CLI writes its keyring entry and ~/.config/roboticks/ directory; remove those manually if you want a clean slate:
rm -rf ~/.config/roboticks # macOS: also clear keychain security delete-generic-password -s "io.roboticks.cli"
Troubleshooting
`rbtk: command not found`
Your PATH is missing the install dir. Common locations:
pipx: ~/.local/bin (Linux/macOS), %USERPROFILE%\.local\bin (Windows)pip --user: python3 -m site --user-base/binHomebrew: $(brew --prefix)/bin
Run which python3 then python3 -m pipx ensurepath to fix pipx PATH automatically.
Python 3.10 not available
macOS: Ubuntu 22.04 ships 3.10; on 20.04 use deadsnakes: sudo add-apt-repository ppa:deadsnakes/ppa sudo apt install python3.12
Then point pipx at the new interpreter: pipx install --python python3.12 roboticks-cli
Behind a corporate proxy or MITM: pip install --proxy http://proxy.corp:3128 roboticks-cli pip config set global.cert /path/to/corp-ca.pem
Next
Authenticate OAuth, API keys, GitHub OIDC.
Commands reference All command groups, one page.
