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

# Quickstart

> Install Sparkle, sign in, and apply guardrails to your first AI coding task.

Get Sparkle running in your IDE or terminal and confirm guardrails are active. Takes about five minutes.

## 1. Install Sparkle

Pick the tool you code with:

<CardGroup cols={3}>
  <Card title="Cursor" icon="https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/cursor.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=4f6cd524bb629ea339269b8693183913" href="/extension/cursor" width="24" height="24" data-path="images/icons/cursor.svg">
    Install Sparkle Guardrails extension in Cursor.
  </Card>

  <Card title="Windsurf" icon="https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/windsurf.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=b5214bd9bd254b2f2e876455145c5a84" href="/extension/windsurf" width="24" height="24" data-path="images/icons/windsurf.svg">
    Install Sparkle Guardrails extension in Windsurf.
  </Card>

  <Card title="VS Code" icon="https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/visualstudiocode.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=17b87f4fa3d302d61a7b3ade41a6d10c" href="/extension/vscode" width="24" height="24" data-path="images/icons/visualstudiocode.svg">
    Install the Sparkle Guardrails extension in VS Code.
  </Card>

  <Card title="CLI only" icon="terminal" href="/cli/install">
    Install the CLI and configure all detected tools.
  </Card>

  <Card title="Claude Code" icon="https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/claude.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=8c30d466bc6ed5bafac8137e3f163199" href="/cli/claude-code" width="24" height="24" data-path="images/icons/claude.svg">
    Configure Claude Code with the Sparkle CLI.
  </Card>

  <Card title="Codex" icon="https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/openai.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=0eda882e4e8873964dcf890d8bd095a7" href="/cli/codex" width="24" height="24" data-path="images/icons/openai.svg">
    Configure Codex with the Sparkle CLI.
  </Card>
</CardGroup>

<Tip>
  The CLI can take care of coding agents and IDEs automatically after sign-in. If you use the CLI, you can skip the IDE extension steps below.
</Tip>

## 2. Sign in

**Extension:** open the Sparkle sidebar in your IDE and complete the sign-in flow.

**CLI:**

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

`sparkle login` opens your browser for OAuth. `sparkle setup` auto-detects installed AI coding tools and wires each one with the Sparkle MCP server, hooks, and guardrail rules.

## 3. Run a coding task

Ask your agent to write or change code as you normally would. Before it plans or generates, Sparkle fetches the guardrails for that repo via the `get_guardrails` MCP tool and injects them into the agent's context.

Once the code is generated you will see a **Sparkle Guardrails Applied** summary at the end of the agent's response, which lists the rules it followed.

<Check>
  If you see the `get_guardrails` call and a guardrails summary, Sparkle is working. Every subsequent AI coding task in this repo is covered.
</Check>

## Next steps

<CardGroup cols={2}>
  <Card title="Using the extension" href="/extension/usage" icon="plug">
    Sidebar, commands, and settings.
  </Card>

  <Card title="Using the CLI" href="/cli/usage" icon="terminal">
    Full CLI workflow and supported tools.
  </Card>
</CardGroup>