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

# Commands

> Sparkle CLI command reference.

Reference for all Sparkle CLI commands, options, and supported IDE values.

## Command overview

| Command          | Description                                                           |
| ---------------- | --------------------------------------------------------------------- |
| `sparkle login`  | Authenticate with Sparkle via browser OAuth                           |
| `sparkle setup`  | Configure supported AI coding tools with Sparkle                      |
| `sparkle status` | Show login and setup state                                            |
| `sparkle logout` | Sign out or remove config for all IDEs/coding agents or  specific one |

## sparkle login

Authenticate with Sparkle and store your session locally.

```bash theme={null}
sparkle login
```

Opens your browser to complete OAuth sign-in. Session data is saved under `~/.sparkle/`.

## sparkle setup

Wire up supported tools with the Sparkle MCP server, IDE hooks, and guardrail rules.

Configure all detected tools:

```bash theme={null}
sparkle setup
```

Configure a specific tool:

```bash theme={null}
sparkle setup --ide cursor
```

### Options

| Option          | Description                                                   |
| --------------- | ------------------------------------------------------------- |
| `--ide <value>` | Target a specific IDE. See [Supported IDEs](#supported-ides). |

## sparkle status

Show whether you are logged in and which tools are configured.

```bash theme={null}
sparkle status
```

## sparkle logout

Sign out of Sparkle on your machine.

```bash theme={null}
sparkle logout
```

Remove Sparkle configuration for one tool:

```bash theme={null}
sparkle logout --ide cursor
```

### Options

| Option          | Description                           |
| --------------- | ------------------------------------- |
| `--ide <value>` | Remove config for a specific IDE only |

## Supported IDEs/Coding Agents

| Tool                             | `--ide` value |
| -------------------------------- | ------------- |
| [Cursor](https://cursor.com)     | `cursor`      |
| [Claude Code](/cli/claude-code)  | `claudeCode`  |
| [Windsurf](https://windsurf.com) | `windsurf`    |
| [Codex](/cli/codex)              | `codex`       |

## Requirements

* Node.js **20+** (for npm install)
* A Sparkle account — [sign up for free](https://app.thesparkle.ai)

## Related pages

<CardGroup cols={2}>
  <Card title="Install CLI" icon="download" href="/cli/install">
    Install the CLI on your machine.
  </Card>

  <Card title="Using the CLI" icon="terminal" href="/cli/usage">
    Typical CLI workflows and setup.
  </Card>
</CardGroup>