CLI Overview
The snippbot CLI manages the daemon, projects, devices, channels, secrets, authentication, the Singularity marketplace, and more — a total of 18 command groups.
Quick reference
Section titled “Quick reference”| Command | Description |
|---|---|
snippbot start | Start the daemon |
snippbot stop | Stop the daemon |
snippbot restart | Restart the daemon (stop, then start) |
snippbot status | Check daemon status |
snippbot config | Manage configuration |
snippbot project | Manage projects |
snippbot agents | Manage agent workspaces (v1→v2 layout migration) |
snippbot channel | Manage messaging channels |
snippbot device | Manage paired devices |
snippbot setup | Run installation wizard |
snippbot doctor | Diagnose system health |
snippbot reset | Reset installation |
snippbot uninstall | Uninstall Snippbot (stop, remove service, optional --purge) |
snippbot upgrade | Reliably upgrade to the latest (or a pinned) version |
snippbot service | Run the daemon as a managed OS service (systemd/launchd/Task Scheduler) |
snippbot secrets | Manage encrypted secrets |
snippbot auth | Manage user account & API keys |
snippbot export | Export data as JSON |
snippbot security | Security scans & findings |
snippbot skills | Skill vetting & verification |
snippbot marketplace | Singularity Marketplace |
snippbot dispatcher | Inspect the unified-dispatcher decision log (tail / mismatches / health / stats) |
snippbot completions | Shell completion scripts (bash/zsh/fish) |
Installation
Section titled “Installation”The CLI is installed as part of Snippbot. We recommend pipx, which installs it into an isolated environment and puts snippbot on your PATH:
pipx install snippbot # Installs the snippbot CLI + daemonSee Installation for the full setup (and the pip-into-a-venv alternative).
Verify installation:
snippbot --versionsnippbot --helpCommon first-run workflow
Section titled “Common first-run workflow”snippbot setup # Run interactive setup wizardsnippbot start # Start the daemonsnippbot status # Verify it's running# Open http://localhost:18781 in your browserGlobal options
Section titled “Global options”All snippbot commands support:
| Option | Description |
|---|---|
--help | Show help for any command |
--version | Show version number |
Sub-command structure
Section titled “Sub-command structure”Each top-level command has sub-commands:
snippbot├── start├── stop├── restart├── status├── config│ ├── list│ ├── get <key>│ ├── set <key> <value>│ ├── delete <key>│ ├── path│ └── init├── project│ ├── list│ ├── show <id>│ ├── approve <id>│ └── cancel <id>├── channel│ ├── start│ ├── stop│ ├── status│ └── list├── device│ ├── list│ ├── info <id>│ ├── revoke <id>│ ├── block <id>│ ├── delete <id>│ └── exec <id> <tool>├── setup├── doctor├── reset├── upgrade├── secrets│ ├── set <name>│ ├── get <name>│ ├── list│ ├── delete <name>│ ├── rotate <name>│ ├── export│ ├── import <file>│ └── audit├── auth│ ├── create-user│ ├── change-password│ ├── status│ ├── create-key│ ├── list-keys│ ├── revoke-key <id>│ └── regenerate-key <id>├── export│ ├── conversations│ ├── projects│ └── all├── security│ ├── scan│ ├── report│ ├── findings│ └── history├── skills│ ├── verify <path>│ └── scan <path>├── marketplace│ ├── search [query]│ ├── install <ref>│ ├── uninstall <ref>│ ├── list│ ├── info <ref>│ ├── publish [dir]│ ├── login│ ├── logout│ ├── whoami│ ├── register│ ├── init [dir]│ ├── update│ └── ... (see marketplace page for advanced commands)└── completions <shell>Related pages
Section titled “Related pages”- start / stop / status — daemon lifecycle
- config — configuration management
- project — project management
- setup / doctor — setup and diagnostics
- upgrade — reliably upgrade Snippbot
- device — device management
- channel — channel management
- secrets — encrypted secret store
- auth — daemon user account & API keys
- export — data export
- security / skills — security scans & skill vetting
- marketplace — Singularity Marketplace
- completions — shell completion scripts
