Skip to main content

Configuration

Use configuration to make runtime defaults, integrations, costs, and portability visible to the project owner.

Runtime
Set server, database, model, and dispatch defaults.
Integrations
Configure GitHub and MCP from explicit project surfaces.
Cost
Choose how model usage is accounted for and reviewed.

Runtime

The app runs as a local monorepo during development:

pnpm run dev

The backend defaults to http://localhost:3000; the frontend defaults to http://localhost:5173.

Database

Squadboard uses embedded Postgres-compatible storage by default. For an external database, set DATABASE_URL:

export DATABASE_URL="postgresql://user:pass@host:5432/squadboard"

Squad state also defaults to the PostgreSQL-backed provider. Use pnpm run dev:fs, squadboard init --squad-storage fs, or SQUADBOARD_SQUAD_STORAGE_PROVIDER=fs only when you want repository .squad/ files to stay as the live state store.

Project defaults

Useful environment variables:

VariablePurpose
SQUADBOARD_DEFAULT_PROJECT_IDDefault project for MCP tools and capture flows
SQUADBOARD_SQUAD_STORAGE_PROVIDERpostgresql (default) or fs filesystem fallback for Squad state
SQUADBOARD_COST_MODELUse usd or ai_credits cost accounting (gh_multipliers is a legacy alias)
COORDINATOR_DISPATCH_ENABLEDSet 0 to disable coordinator dispatch
COORDINATOR_MODELPrimary model for bounded coordinator judgment
COORDINATOR_MODEL_FALLBACKSComma-separated fallback model chain

GitHub

Projects can use a personal access token or GitHub App credentials. Configure GitHub from the UI or via PUT /api/projects/:projectId/github.

Ralph monitor

Ralph autonomy is project-level opt-in. Disabled projects never run autonomous monitor actions.

Docs site

The Docusaurus package lives in packages/docs-site.

pnpm docs:dev
pnpm docs:build
pnpm docs:serve

prebuild and prestart regenerate llms.txt and llms-full.txt.