# Install

Tell your agent to install NimWiki and it finds the rest, or install by hand in Claude Code, Codex or any MCP agent, with no account and no app to install.

## Tell your agent

Paste this into Claude Code, Codex, Cursor or any coding agent:

```
Install NimWiki by following https://nimwiki.com/docs/getting-started/install/
```

The agent reads this page, picks the right install for itself, and tells you if it needs you to start a new session. Then ask it for a wiki in one sentence:

> Build a strategy wiki for Cloudflare from its filings, earnings calls and product docs.

The [Quickstart](/docs/getting-started/quickstart/) walks through what happens next. To install by hand, use the steps below.

---

## Manual install

### Claude Code

Paste these two lines into Claude Code, then start a new session:

```
/plugin marketplace add nimbalyst/nimbalyst-wiki
/plugin install nimbalyst-wiki@nimbalyst-wiki
```

If you prefer the terminal, the same install runs as `claude plugin marketplace add nimbalyst/nimbalyst-wiki` then `claude plugin install nimbalyst-wiki@nimbalyst-wiki`.

### Codex

Run these two lines in a terminal, then start a new Codex session:

```sh
codex plugin marketplace add nimbalyst/nimbalyst-wiki
codex plugin add nimbalyst-wiki@nimbalyst-wiki
```

Cursor, VS Code, Cowork and other MCP agents use the same wiki through a command line tool; see [Other agents](#other-agents) below.

---

The rest of this page covers what the install needs, what the plugin adds, and how to check it.

## Requirements

- **Node.js 22 or later** on your `PATH`, with the npm that comes with it. The plugin runs its wiki server through `npx`, so the first session downloads it, including the browser view. Later sessions use npm's cache and work offline.
- **An agent:** Claude Code, Codex, or any agent that can use an MCP server.

You do not need an account for a local wiki. You sign in only when you move a wiki to a team.

Check your Node version:

```sh
node --version
```

## What the plugin adds

The plugin adds the wiki tools and the skills that tell the agent how to write pages, and it downloads the rest the first time a session starts. If you installed it inside a running Claude Code session, run `/reload-plugins` or start a new session so it loads.

In Claude Code the plugin also adds two hooks: at the start of a session it tells the agent what the wiki covers, and after a session with substantial work it reminds the agent once to record what you decided.

<div class="docs-hint docs-hint-info" role="note">

Codex does not run plugin hooks, so it does not remind you to record decisions at the end of a session. Ask it to "record what we decided in the wiki" when you are done. Quotes from your own words are read from Claude Code transcripts only, so decisions recorded from Codex carry your name but no quote.

</div>

## Other agents

Cursor, VS Code with Copilot in agent mode, Cowork, the Codex app and any other MCP client use the wiki through the `nim` command line, which runs the same local wiki server the plugin uses.

1. Install `nim`:

   ```sh
   npm install -g @nimbalyst/cli
   ```

2. Add the server to your agent's MCP config:

   | Agent | Config file | Workspace argument |
   | --- | --- | --- |
   | Cursor | `.cursor/mcp.json` (key `mcpServers`) | `${workspaceFolder}` |
   | VS Code, Copilot in agent mode | `.vscode/mcp.json` (key `servers`) | `${workspaceFolder}` |
   | Cowork | The Claude desktop app's MCP config (key `mcpServers`) | `/path/to/your/project` |
   | Codex app, any MCP client | Your client's MCP config | Your project path |

   ```json
   {
     "mcpServers": {
       "wiki": {
         "command": "nim",
         "args": ["mcp", "--workspace", "${workspaceFolder}"]
       }
     }
   }
   ```

   If the agent cannot find `nim`, use the full path that `which nim` prints.

3. Ask the agent to "start a wiki for this repo."

These agents get the wiki tools but not the plugin's skills, so ask for what you want in your own words. A wiki started in one agent is ready in all the others, because they all read and write the same files.

Installing the plugin does not update `nim`, and updating `nim` does not update the plugin. See [Upgrade](/docs/reference/upgrade/).

## Check the install

Ask your agent "what can the wiki plugin do?" for a short tour, or go straight to the [Quickstart](/docs/getting-started/quickstart/).

To see which versions you have, install `nim` (above) and run:

```sh
nim doctor
```

It lists the `nim` version, the browser view it uses, and the wiki plugins installed for Claude Code and Codex.