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

# Windsurf Setup

> Install and configure Sparkle in Windsurf.

Install the Sparkle Guardrails extension in Windsurf to apply security guardrails on every AI prompt.

## Prerequisites

* [Windsurf](https://windsurf.com) installed on your machine
* A Sparkle account (sign in after installation)

## Install from the marketplace

Windsurf uses the [Open VSX Registry](https://open-vsx.org) for extensions.

<Steps>
  <Step title="Open the Extensions panel">
    Press **Cmd+Shift+X** (Mac) or **Ctrl+Shift+X** (Windows/Linux), or click the Extensions icon in the activity bar.
  </Step>

  <Step title="Search for Sparkle Guardrails">
    Search for **Sparkle Guardrails** or `thesparkle.sparkle-guardrails`.
  </Step>

  <Step title="Install the extension">
    Select **Sparkle Guardrails** published by **thesparkle**, then click **Install**.
  </Step>
</Steps>

<Tip>
  You can also open the extension page directly on Open VSX: [Sparkle Guardrails](https://open-vsx.org/extension/thesparkle/sparkle-guardrails).
</Tip>

## Install from a VSIX file

If the extension does not appear in the marketplace, install it manually from Open VSX.

<Steps>
  <Step title="Download the VSIX file">
    Open [Sparkle Guardrails on Open VSX](https://open-vsx.org/extension/thesparkle/sparkle-guardrails) and download the `.vsix` file.
  </Step>

  <Step title="Install from VSIX">
    In the Extensions panel, open the **...** menu and select **Install from VSIX...**. Choose the downloaded file.

    Alternatively, open the Command Palette (**Cmd+Shift+P** or **Ctrl+Shift+P**) and run **Extensions: Install from VSIX...**.
  </Step>

  <Step title="Reload Windsurf">
    Reload the window if prompted.
  </Step>
</Steps>

## Sign in

After installation, open Sparkle in Windsurf and complete the sign-in flow with your Sparkle account.

## Verify installation

<Steps>
  <Step title="Confirm the extension is enabled">
    In the Extensions panel, confirm **Sparkle Guardrails** appears under **Installed**.
  </Step>

  <Step title="Open a project">
    Open the repository you want to protect with Sparkle.
  </Step>

  <Step title="Run a prompt">
    Use Windsurf's AI features in that project. Sparkle applies guardrails on every prompt.
  </Step>
</Steps>

## Next steps

<CardGroup cols={2}>
  <Card title="Using the Extension" href="/extension/usage" icon="plug">
    Learn the basic extension workflow.
  </Card>

  <Card title="Troubleshooting" href="/help/troubleshooting" icon="wrench">
    Fix common installation issues.
  </Card>
</CardGroup>