Docs

Learn Clavue from first install to advanced team workflows.

Use these pages as the product manual: install, provider setup, daily workflows, commands, permissions, security, and troubleshooting.

GitHub

Quickstart

Quickstart

Install Clavue, launch it in a repository, choose a setup mode, and ask for one reviewable unit of work.

  • Run once with npx or install globally
  • Choose official login, custom API, CCR proxy, or manual setup
  • Ask for a concrete task with verification
npx -y clavue@8.22.5

# first useful prompt
Inspect the failing test, make the smallest source fix, run the targeted test, then verify before reporting back.

Install

Install

Use a one-shot npx run, global npm install, or pinned curl installer.

  • Node.js 18 or newer
  • macOS or Linux shell
  • Pinned release commands available
npx -y clavue@8.22.5 --version
npx -y clavue@8.22.5

npm install -g clavue@8.22.5
clavue install --force
clavue

curl -fsSL https://unpkg.com/clavue@8.22.5/install.sh | bash -s -- 8.22.5

Provider setup

Provider setup

Treat providers as routes. Save profiles, validate them, repair drift, and route model slots deliberately.

  • Official login is optional
  • Custom API and proxy routes are supported
  • Use CLAVUE_API_DIALECT=openai_responses only when required
clavue provider
/provider
/provider list
/provider current
/provider doctor
/provider validate
/provider repair
/provider use gpt54-main

Commands

Commands

Use slash commands as reusable workflow entry points.

  • /provider for route control
  • /mao for review and rescue
  • /team for readiness
  • /retro for improvement loops
/provider doctor
/mao review --background
/mao rescue --write fix the provider override bug and verify it
/team check
/retro onboarding and route validation

Best practices

Best practices

Keep scope tight, require verification, and ask for one reviewable unit at a time.

  • Prefer concrete tasks over vague goals
  • Name what should not change
  • Run targeted checks before broad gates
Fix the failing auth retry test, make the smallest source change, and run the targeted test.

Do not refactor unrelated provider code. Keep this to the failing validation path.

Security and trust

Security and trust

Clavue is designed for explicit local execution, permission boundaries, and concrete verification.

  • Ask before destructive or shared-state actions
  • Inspect active routes with /provider current
  • Verify before claiming completion
/approvals
/provider current
/provider validate
CLAVUE_USE_KEYCHAIN=1 clavue # optional old macOS Keychain behavior