Get started in minutes
One command to install. A setup wizard to configure. You're running autonomous agents in under 5 minutes.
Quick Install
One command — works the same on macOS, Linux, and Windows. Installs the snippbot CLI and daemon, with the compiled UI and agent gateway bundled in. No Node.js, pnpm, or repo clone required.
Don't have pipx? Install it from pipx.pypa.io — or use pip inside a virtualenv: python3 -m venv ~/.snippbot-venv && ~/.snippbot-venv/bin/pip install snippbot.
Prerequisites
Getting started
Three commands and you're live — under five minutes from install to running agents.
- 1 Install the package
pipx install snippbotPulls one self-contained wheel with the compiled UI and agent gateway bundled in. - 2 Run the setup wizard
snippbot setupOpens http://localhost:18781/setup for first-time configuration. - 3 Start the daemon
snippbot startLaunches the daemon and its agent gateway on port 18781.
System requirements
| Requirement | Minimum |
|---|---|
| Python | 3.11+ |
| RAM | 512 MB |
| Disk | 300 MB |
| OS | macOS, Linux, Windows |
Useful commands
| Command | Description |
|---|---|
| snippbot setup --headless | Configure from the terminal — no browser (servers / SSH) |
| snippbot setup --host 0.0.0.0 | Bind to all interfaces for remote / VM access |
| snippbot setup --port 18781 | Use a custom API + UI port |
| snippbot service install | Run as a managed service — start on login + auto-restart (no sudo) |
| snippbot doctor | Run a full health check on your install |
| snippbot uninstall | Stop the daemon and remove Snippbot (--purge also deletes data) |
After installation
Run on startup
snippbot start runs in the foreground. To launch Snippbot automatically on login and restart it if it crashes, register it as a managed service — one command, no sudo, picking the right mechanism for your OS (systemd on Linux, launchd on macOS, Task Scheduler on Windows).
Headless Linux servers (no logged-in user): run loginctl enable-linger $USER after install so it stays up without a session — or use scripts/install-vps.sh --service for a boot-time system service.
Run on a server (VPS)
Install the same way, then bind to all interfaces so you can reach the UI across your network:
Then open http://<server-ip>:18781/ (the setup wizard loads automatically). If a firewall blocks it, allow the port (e.g. sudo ufw allow 18781/tcp). To keep it running, register it as a service (see Run on startup above) — on a headless server use scripts/install-vps.sh --service for a boot-time systemd unit.
Optional — Claude CLI backend. To run agents on your Claude Pro/Team account via the local Claude CLI, you also need Node.js 18+ plus npm install -g @anthropic-ai/claude-code (a global install needs sudo on a server). Our scripts/install-vps.sh --with-claude-cli sets this up for you. You can skip it and run on an Anthropic API key instead.
Setup wizard
The first time you run Snippbot, an 8-step setup wizard guides you through initial configuration:
Licensing
Snippbot is free for personal use. You may use, modify, and run it for personal, educational, and non-commercial purposes at no cost.
Commercial use requires a license. Using Snippbot or derivatives to generate revenue, in a business context, or as part of a commercial product or service requires a commercial license agreement. See our Terms of Service for details.
By downloading and installing Snippbot, you agree to our Terms of Service. Snippbot is provided "as is" without warranty. Snippai LLC is not liable for any damages arising from use of the software. You use Snippbot at your own risk.
For detailed installation instructions, troubleshooting, and advanced configuration:
Full Installation Guide