Skip to content

CLI Overview

The snippbot CLI manages the daemon, projects, devices, channels, secrets, authentication, the Singularity marketplace, and more — a total of 17 command groups.

CommandDescription
snippbot startStart the daemon
snippbot stopStop the daemon
snippbot statusCheck daemon status
snippbot configManage configuration
snippbot projectManage projects
snippbot channelManage messaging channels
snippbot deviceManage paired devices
snippbot setupRun installation wizard
snippbot doctorDiagnose system health
snippbot resetReset installation
snippbot secretsManage encrypted secrets
snippbot authManage user account & API keys
snippbot exportExport data as JSON
snippbot securitySecurity scans & findings
snippbot skillsSkill vetting & verification
snippbot marketplaceSingularity Marketplace
snippbot completionsShell completion scripts (bash/zsh/fish)

The CLI is installed as part of Snippbot:

Terminal window
pip install snippbot # Installs snippbot CLI globally

Or from source:

Terminal window
pip install -e packages/cli # Install from monorepo

Verify installation:

Terminal window
snippbot --version
snippbot --help
Terminal window
snippbot setup # Run interactive setup wizard
snippbot start # Start the daemon
snippbot status # Verify it's running
# Open http://localhost:18781 in your browser

All snippbot commands support:

OptionDescription
--helpShow help for any command
--versionShow version number

Each top-level command has sub-commands:

snippbot
├── start
├── stop
├── 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
├── 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>