Skip to content
GitHub

Setup

Install

Use the workspace commands while Warden is under active development. The published CLI target is already shaped, but npm publication is separate from this site scaffold.

  1. Install dependencies

    Use the pinned pnpm workspace so every package resolves against the same lockfile.

  2. Build packages

    Compile the package outputs used by local CLI runs and static site fixtures.

  3. Initialize the index

    Create the local embedding-backed context index. Re-running is safe and cache-aware.

  4. Run a review

    Start with check for deterministic-only output, or review for the full cited review spine.

Workspace setuplocal clone
pnpm install
pnpm build
pnpm warden init
pnpm warden review
Published targetfuture npm path
npx warden review

The npm publication step is separate from this site scaffold.

ANTHROPIC_API_KEYRequired for warden review. Warden validates it at startup so failures are explicit.
VOYAGE_API_KEYRequired for warden init and semantic context indexing. Without it, review falls back to cheap signals.
GOOGLE_GENERATIVE_AI_API_KEYOptional fallback when Anthropic has a transient provider failure.
.envlocal only
ANTHROPIC_API_KEY=sk-ant-...
VOYAGE_API_KEY=pa-...
Cache behavior

warden init writes the local index to .warden/cache.sqlite. The file is gitignored, can be deleted, and can be rebuilt from source.