Getting started

Installation

Set up a new or existing project, install the plugin, and check the result.

Requirements

  • Node.js ≥ 20.11 and npm.
  • Claude Code (CLI, desktop app or IDE extension).
  • Git is recommended: the git guard and preflight work on the repository.

Set up a project

Run init

Terminal
npx @razcue/agent-kit init my-project

In an existing repository, run it inside the folder: cd my-repo && npx @razcue/agent-kit init. Your AGENTS.md is kept and gets a managed block.

Answer the questions

QuestionChoices
SetupNew app monorepo (web + app + docs on Nuxt + Supabase) · New content site (one Nuxt site with Markdown pages) · Existing project (agent layer only) · Blank project (agent layer only, no template)
Apps (monorepo)web, app, docs
Technical levelTechnical (concise developer language) · Non-technical (plain language; the agent makes technical decisions)
Agent reply languageEnglish · Español
Development methodSDD + TDD (tests first, enforced) · SDD (every scenario verified by a test or a check)
Commit messagesConventional Commits (commitlint + git hook) · Free-form
Git flow for the agentBranches + pull requests · Trunk · Read-only (you run git yourself)
Main (production) branchDetected from git — origin's HEAD, or the only main / master / trunk / production / prod branch; asked only when not sure (--main <branch>)
Stack conventions skill (existing / blank)None · Nuxt + Supabase · Nuxt Content site
QA checklistGenerated from the living specs in work/qa/ (default yes)
Supabase test data (Supabase projects)seed / purge scripts in supabase/test-data/ (default yes)
Supabase project ref (optional)Adds a read-only, project-scoped Supabase MCP server to .mcp.json

init shows the plan and asks before writing. Every file it changes is backed up in .agent-kit/backups/.

Open Claude Code in the project

Terminal
cd my-project && npm install && claude

Trust the folder. .claude/settings.json declares the agent-kit marketplace and enables agent-kit@agent-kit, so Claude Code offers to install the plugin — accept. If it doesn't:

Claude Code
/plugin marketplace add razcue/agent-kit
/plugin install agent-kit@agent-kit

Check the setup

Terminal
npx @razcue/agent-kit doctor

agent-kit doctor checks the answers, the AGENTS.md block, the plugin, the knowledge and script indexes, the context budget and the stack skill. --fix regenerates everything that is generated (indexes, the work board, the QA checklist).

Non-interactive setup

Every question has a flag; --yes takes the defaults for the rest:

Terminal
npx @razcue/agent-kit init shop --yes --kind monorepo --apps web,app,docs \
  --level technical --lang en --method sdd-tdd --commits conventional --git pr \
  --qa-checklist true --test-data true --test-prefix TEST_

All flags are listed in the CLI reference.

Change an answer later

Re-run init with the new value; it only touches the agent layer:

Terminal
npx @razcue/agent-kit init --git read-only --yes

Make global knowledge writable (kit maintainers)

Projects read the global knowledge bundled with the plugin. To write global entries from your machine, register a clone of the kit:

Terminal
git clone https://github.com/razcue/agent-kit.git && cd agent-kit
npx @razcue/agent-kit setup

agent-kit setup writes ~/.config/agent-kit/config.json; agents then save global knowledge and improvement proposals into that clone.