> ## 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.

# Using the CLI

> Run Sparkle from the terminal.

Use the Sparkle CLI to sign in, configure your AI coding tools, and verify that guardrails are active in your local workflow.

## Quick start

<Steps>
  <Step title="Sign in">
    Authenticate with Sparkle via browser OAuth:

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

    Your session is stored locally under `~/.sparkle/`.
  </Step>

  <Step title="Set up your tools">
    Configure all detected AI coding tools:

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

    `sparkle setup` auto-detects installed tools and wires each one with the Sparkle MCP server, IDE hooks, and guardrail rules.
  </Step>

  <Step title="Verify status">
    Check your login and setup state:

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

    This shows whether you are logged in and which tools are configured.
  </Step>
</Steps>

## Configure a specific IDE

To set up one tool instead of all detected tools, pass the `--ide` flag:

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

See [Supported IDEs](#supported-ides) for all `--ide` values.

## Sign out

Sign out machine-wide:

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

To remove Sparkle configuration for a single tool:

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

## What setup configures

When you run `sparkle setup`, the CLI:

* Connects your CLI & IDE to the Sparkle MCP server
* Installs and wires up relevant hooks
* Registers guardrail for your workspace

## Use the extension instead

You can also use the [Sparkle Guardrails extension](/extension/usage) for VS Code, Cursor, and Windsurf. The extension bundles this CLI and delegates setup to it.

## 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`       |