---
title: "Installation"
description: "Set up a new or existing project, install the plugin, and check the result."
canonical_url: "https://razcue-agent-kit.vercel.app/en/getting-started/installation"
---
# 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

<steps>

### Run `init`

```bash [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

<table>
<thead>
  <tr>
    <th>
      Question
    </th>
    
    <th>
      Choices
    </th>
  </tr>
</thead>

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

`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

```bash [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:

```text [Claude Code]
/plugin marketplace add razcue/agent-kit
/plugin install agent-kit@agent-kit
```

### Check the setup

```bash [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).

</steps>

## Non-interactive setup

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

```bash [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](https://razcue-agent-kit.vercel.app/en/reference/cli#agent-kit-init).

## Change an answer later

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

```bash [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:

```bash [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.


## Sitemap

See the full [sitemap](https://razcue-agent-kit.vercel.app/sitemap.md) for all pages.