Skip to main content
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:
https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/cursor.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=4f6cd524bb629ea339269b8693183913

Cursor

Install Sparkle Guardrails extension in Cursor.
https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/windsurf.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=b5214bd9bd254b2f2e876455145c5a84

Windsurf

Install Sparkle Guardrails extension in Windsurf.
https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/visualstudiocode.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=17b87f4fa3d302d61a7b3ade41a6d10c

VS Code

Install the Sparkle Guardrails extension in VS Code.

CLI only

Install the CLI and configure all detected tools.
https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/claude.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=8c30d466bc6ed5bafac8137e3f163199

Claude Code

Configure Claude Code with the Sparkle CLI.
https://mintcdn.com/sparklesecurity/nnlgrfQpL6_abGfp/images/icons/openai.svg?fit=max&auto=format&n=nnlgrfQpL6_abGfp&q=85&s=0eda882e4e8873964dcf890d8bd095a7

Codex

Configure Codex with the Sparkle CLI.
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.

​
2. Sign in

Extension: open the Sparkle sidebar in your IDE and complete the sign-in flow. CLI: 
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.
If you see the get_guardrails call and a guardrails summary, Sparkle is working. Every subsequent AI coding task in this repo is covered.

​
Next steps

Using the extension

Sidebar, commands, and settings.

Using the CLI

Full CLI workflow and supported tools.