CLI state
The CLI stores session and configuration data under~/.sparkle/:
| Data | Purpose |
|---|---|
| Session | OAuth session created by sparkle login |
| Tool configuration | Which IDEs and agents sparkle setup has wired up |
sparkle logout clears the session machine-wide. sparkle logout --ide <value> removes configuration for one tool without signing out.
Extension settings
Configure the extension under Settings → search for Sparkle Guardrails:| Setting | Default | Description |
|---|---|---|
sparkle-guardrails.telemetryEnabled | true | Upload telemetry data to Sparkle |
sparkle-guardrails.debug | false | Enable debug logging for troubleshooting |
debug before running Sparkle: Diagnose if you need logs to share with team@sparkle.security.
Supported --ide values
Used with sparkle setup --ide <value> and sparkle logout --ide <value>:
| Tool | Value |
|---|---|
| Cursor | cursor |
| Claude Code | claudeCode |
| Windsurf | windsurf |
| Codex | codex |
What setup writes
sparkle setup configures each tool with:
- The Sparkle MCP server connection, which exposes the
get_guardrailstool - Sparkle hooks, which runs on prompts, MCP calls, file edits, and session events
- Guardrail rules for your workspace
sparkle setup to repair or update a tool’s configuration.
Related pages
Commands
Full CLI command reference.
Troubleshooting
Fix login, sync, and connection issues.