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.
Installation
Requirements
- Python 3.10 or higher
- pip or pipx
Install Methods
pip (Standard)
pipx (Recommended)
From Source
pip install roboticks-cli
# Install pipx if you don't have it
pip install pipx
pipx ensurepath
# Install roboticks-cli in isolated environment
pipx install roboticks-cli
pipx installs the CLI in an isolated environment, avoiding conflicts with other Python packages.
git clone https://github.com/roboticks-io/roboticks-cli.git
cd roboticks-cli
pip install -e ".[dev]"
Verify Installation
rbtk --version
# roboticks-cli 0.1.0
rbtk --help
# Shows available commands
Shell Completions
Enable tab completion for your shell:
Bash
Zsh
Fish
Auto-Install
# Add to ~/.bashrc
rbtk completion bash >> ~/.bashrc
source ~/.bashrc
# Add to ~/.zshrc
rbtk completion zsh >> ~/.zshrc
source ~/.zshrc
rbtk completion fish > ~/.config/fish/completions/rbtk.fish
# Automatically install for your current shell
rbtk completion install
Updating
# pip
pip install --upgrade roboticks-cli
# pipx
pipx upgrade roboticks-cli
Uninstalling
# pip
pip uninstall roboticks-cli
# pipx
pipx uninstall roboticks-cli
# Remove shell completions
rbtk completion uninstall
Troubleshooting
Make sure your Python scripts directory is in your PATH:# Check where pip installs scripts
python -m site --user-base
# Add to PATH (usually ~/.local/bin on Linux/macOS)
export PATH="$HOME/.local/bin:$PATH"
Use pip install --user or install with pipx:pip install --user roboticks-cli
# or
pipx install roboticks-cli
Ensure you’re using Python 3.10+:python --version
# If needed, use a specific version
python3.10 -m pip install roboticks-cli
Next Steps
Authentication
Set up authentication to start using the CLI
