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

Quick start

1

Sign in

Authenticate with Sparkle via browser OAuth:
sparkle login
Your session is stored locally under ~/.sparkle/.
2

Set up your tools

Configure all detected AI coding tools:
sparkle setup
sparkle setup auto-detects installed tools and wires each one with the Sparkle MCP server, IDE hooks, and guardrail rules.
3

Verify status

Check your login and setup state:
sparkle status
This shows whether you are logged in and which tools are configured.

Configure a specific IDE

To set up one tool instead of all detected tools, pass the --ide flag:
sparkle setup --ide cursor
See Supported IDEs for all --ide values.

Sign out

Sign out machine-wide:
sparkle logout
To remove Sparkle configuration for a single tool:
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 for VS Code, Cursor, and Windsurf. The extension bundles this CLI and delegates setup to it.

Supported IDEs/Coding Agents

Tool--ide value
Cursorcursor
Claude CodeclaudeCode
Windsurfwindsurf
Codexcodex