Skip to content

setup / doctor / reset

Launch the Snippbot installation wizard.

Terminal window
snippbot setup # Browser-based wizard (default)
snippbot setup --headless # CLI-only interactive setup
snippbot setup --resume # Resume from last completed step
snippbot setup --step api-key # Jump to a specific step
snippbot setup --force # Re-run even if already complete
OptionDefaultDescription
--modeself-hostedself-hosted or cloud
--headlessoffCLI-only setup (no browser)
--port18781Backend API port
--host127.0.0.1Host to bind
--resumeoffResume from last completed step
--stepJump to step: genesis, identity, api-key, ignition, awakening
--forceoffRe-run setup even if already complete

Browser mode (default): Opens http://127.0.0.1:18781/setup in your browser. The 6-step wizard walks through system checks, identity, authentication, voice, model selection, and final verification.

Headless mode: Prompts for display name, email, and API key directly in the terminal. Useful for server environments without a browser.


Run a full health check on your Snippbot installation.

Terminal window
snippbot doctor # Show all diagnostics
snippbot doctor --fix # Auto-fix detected issues
snippbot doctor --json # JSON output
OptionDescription
--fixAttempt to automatically fix detected issues
--jsonOutput as JSON

Checks performed:

CheckWhat it verifies
Python versionPython 3.11+ is installed
Disk spaceSufficient free space for data directory
Port availabilityPorts 18781 and 18790 are not in use
Database integritySQLite databases are valid and readable
API key validityAt least one AI provider API key is configured
Server connectivityDaemon is reachable at configured host/port

Example output:

✓ Python 3.12.2 (3.11+ required)
✓ Disk space: 45.2 GB free
✓ Port 18781 available
✓ Port 18783 available
✓ Database: snippbot.db (OK)
✓ Database: auth.db (OK)
✓ API key: anthropic (configured)
✗ Server: not running (run `snippbot start` to start)

Reset your Snippbot installation. Always creates a backup first.

Terminal window
snippbot reset # Full reset (keeps agent workspaces)
snippbot reset --soft # Reset setup wizard state only
snippbot reset --keep-config # Keep config.toml
snippbot reset --keep-data # Keep databases
snippbot reset --keep-agents # Keep agent workspaces
snippbot reset --force # Skip confirmation prompt
snippbot reset --list-backups # List available backups
snippbot reset --restore # Restore from most recent backup
OptionDescription
--softReset setup state only — fastest way to re-run the wizard
--keep-agentsPreserve agent workspaces
--keep-configPreserve config.toml
--keep-dataPreserve all databases
--forceSkip confirmation prompt
--restoreRestore from most recent backup
--list-backupsList all available backups

Reset levels (least to most destructive):

LevelCommandWhat’s wiped
Softreset --softSetup state only
Partialreset --keep-agentsConfig + databases
FullresetConfig + databases + workspaces

All destructive resets create a timestamped backup in ~/.snippbot/backups/ before proceeding.

Terminal window
# Restore from a backup
snippbot reset --list-backups
# pre-install-20260301-120000
snippbot reset --restore pre-install-20260301-120000