Setup Commands

Instance setup and diagnostics commands. Flags are listed in full on the CLI Reference.

vagaris run

One-command bootstrap and start:

vagaris run

1. Creates the home and instance directories if missing.
2. If no config exists and you are at a terminal, runs onboarding (--bind chooses the preset for that first run); non-interactively it exits 1 and asks you to run vagaris onboard.
3. Runs vagaris doctor with repair enabled (--no-repair disables it) and exits 1 if any check fails.
4. Starts the server. On a first start in authenticated mode with the embedded database it also prints a bootstrap CEO invite.

Choose a specific instance:

vagaris run --instance dev

vagaris onboard

Interactive first-time setup:

vagaris onboard

If Vagaris is already configured, rerunning onboard keeps the existing config in place (it only ensures the agent JWT secret and the local secrets key exist) and offers to start. Use vagaris configure to change settings on an existing install.

First prompt on a fresh install:

1. Quickstart (recommended): local defaults — embedded database, no LLM provider, local-disk storage, locally encrypted secrets.
2. Advanced setup: full interactive configuration.

Start immediately after onboarding:

vagaris onboard --run

Non-interactive defaults plus immediate start (opens the browser when the server listens):

vagaris onboard --yes
vagaris onboard --yes --bind lan

On an existing install, --yes now preserves the current config and just starts Vagaris with that setup. --json prints the resulting configuration summary as JSON.

vagaris doctor

Health checks with optional auto-repair:

vagaris doctor
vagaris doctor --repair --yes
vagaris doctor --json

Validates the config file, deployment/auth mode, agent JWT secret, secrets adapter, storage, database, LLM provider, log directory and server port. The full list and the JSON shape are on Doctor.

vagaris configure

Update configuration sections:

vagaris configure --section server
vagaris configure --section secrets
vagaris configure --section storage

Sections: llm, database, logging, server, storage, secrets. --section secrets updates the deployment-level provider used as the fallback for secrets that do not target a specific company vault; per-company provider vaults live in the board UI under Company Settings → Secrets.

vagaris env

Show the resolved deployment environment:

vagaris env

Prints every deployment variable the config implies with its source (environment, config, file, default) and marks required values that are still missing. Includes the bind settings such as VAGARIS_BIND and VAGARIS_BIND_HOST when configured.

vagaris allowed-hostname

Allow a private hostname for authenticated/private mode:

vagaris allowed-hostname my-tailscale-host

vagaris db:backup

One-off database backup with pruning:

vagaris db:backup --dir ./backups --retention-days 14 --json

Local storage paths

Data	Default path
Config	~/.vagris/instances/default/config.json
Generated secrets (.env)	~/.vagris/instances/default/.env
Database	~/.vagris/instances/default/db
Logs	~/.vagris/instances/default/logs
Storage	~/.vagris/instances/default/data/storage
Backups	~/.vagris/instances/default/data/backups
Secrets key	~/.vagris/instances/default/secrets/master.key

An existing ~/.paperclip home from an earlier install is used in place of ~/.vagris. Override with:

VAGARIS_HOME=/custom/home VAGARIS_INSTANCE_ID=dev vagaris run

Or pass --data-dir directly on any command:

vagaris run --data-dir ./tmp/vagaris-dev
vagaris doctor --data-dir ./tmp/vagaris-dev