> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetodesk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# AI assistants

> Set up NeetoDesk for Claude, Cursor, Copilot, and other AI coding assistants.

Use the CLI with an AI coding assistant to manage NeetoDesk in plain language. The `neetodesk setup` commands add NeetoDesk instructions for your assistant, while [`--toon`](/cli/output-formats) keeps command output compact for it to read.

## Set up your assistant

Run the subcommand for the tool you use:

| Command | What it does |
| - | - |
| `neetodesk setup claude` | Extracts the NeetoDesk plugin (manifest, marketplace, session-start hook, and skill) to `~/.config/neetodesk/claude-plugin`, replacing any earlier copy. Requires `~/.claude/` to exist. |
| `neetodesk setup cursor` | Writes `.cursor/rules/neetodesk.mdc`. Overwrites the file. |
| `neetodesk setup windsurf` | Writes `.windsurf/rules/neetodesk.md`. Overwrites the file. |
| `neetodesk setup copilot` | Adds a NeetoDesk section to `.github/copilot-instructions.md`. Keeps the rest of the file. |
| `neetodesk setup gemini` | Adds a NeetoDesk section to `GEMINI.md`. Keeps the rest of the file. |
| `neetodesk setup codex` | Adds a NeetoDesk section to `AGENTS.md`. Keeps the rest of the file. |

Every subcommand except `setup claude` writes into the current directory, so run it from the root of the project the assistant works in. The `copilot`, `gemini`, and `codex` commands place their section between `<!-- neetodesk:start -->` and `<!-- neetodesk:end -->` markers and replace that section on re-run instead of adding a duplicate. Re-run the command after every CLI upgrade so the instructions match the installed version.

```bash theme={"system"}
neetodesk setup claude
```

`setup claude` prints two slash commands to finish the installation inside Claude Code:

```text theme={"system"}
/plugin marketplace add ~/.config/neetodesk/claude-plugin
/plugin install neetodesk@neetodesk
```

After setup, your assistant can check the commands and flags available in your installed CLI version:

```bash theme={"system"}
neetodesk commands
```

The command prints the complete catalog as JSON.

## Tips for agent workflows

<Tip>
  Prefer `--toon` when the assistant needs to read a list or record, and
  `--quiet` when it needs to pipe an identifier into the next command. See
  [Output formats](/cli/output-formats).
</Tip>

* Authenticate once with [`neetodesk login`](/cli/authentication); the assistant reuses the stored credentials.
* When several workspaces are signed in, the assistant must pass `--subdomain <name>` on each command.
* Run [`neetodesk doctor`](/cli/troubleshooting) first to confirm the assistant is authenticated and connected.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.