Skip to content

CLI reference

Every feedbot subcommand, what it does, and when to use it instead of the dashboard.

The feedbot CLI is installed at /usr/local/bin/feedbot (or ~/.feedbot/bin/feedbot on macOS). It reads .install-state to find your workdir and proxies to docker compose underneath.

Philosophy: the dashboard handles day-to-day stuff (SMTP, Telegram, domain). The CLI is for lifecycle (install / upgrade / uninstall) and escape hatches (logs / exec / doctor) when the UI is unreachable.

CommandWhat it does
feedbot status (or just feedbot)Service health + uptime + version.
feedbot startdocker compose up -d.
feedbot stopdocker compose down.
feedbot restart [service]Restart all or one.
feedbot logs [service] [-f]Tail compose logs (default: follow with --tail=200).
feedbot exec <service> <cmd...>Shell into a container.
CommandWhat it does
feedbot upgradePull latest images and recreate (preserves data).
feedbot self-updateRe-run install.sh --upgrade to refresh the CLI.
feedbot versionShow installed + latest available from GHCR.
feedbot infoPlatform + Docker + image versions.
CommandWhat it does
feedbot doctorComprehensive health check: stack, connectivity, disk, configuration, updates.
feedbot portsShow ports in use vs configured.
feedbot configPrint .env with secrets redacted.
feedbot workdirPrint the install workdir.
CommandWhat it does
feedbot backup [--out=path]pg_dump + .envfeedbot-<ts>.tar.gz.
feedbot list-backupsList <workdir>/backups/.
feedbot restore <file>Restore from a backup (DESTRUCTIVE; triple-confirms).

The backup format matches the orchestrator’s so backups taken via the dashboard’s Settings → Backups page and via this CLI are interchangeable.

CommandWhat it does
feedbot reconfigureRe-run install wizard (mode/workdir/port).
feedbot rotate-secret-keyNew FEEDBOT_SECRET_KEY (DESTRUCTIVE — invalidates sessions + LLM keys).
feedbot rotate-bot-tokenNew FEEDBOT_BOT_TOKEN (bot↔api shared secret).
Terminal window
feedbot uninstall

Triple-confirms, then:

  1. docker compose down -v (removes containers AND volumes — data loss).
  2. rm -rf <workdir>.
  3. Removes the CLI binary.

There’s no recovery from this. If you want to keep data, run feedbot backup first and store the tarball somewhere safe.

  • Pipe feedbot logs into grep for fast filtering: feedbot logs api --no-follow | grep ERROR.
  • feedbot doctor exits non-zero on critical issues — useful in monitoring scripts.
  • feedbot config redacts any key matching *_KEY, *_TOKEN, *_PASSWORD. Empty values stay visible (so you know “not configured” vs “we hid it”).