Command overview
| Command | Description |
|---|---|
sparkle login | Authenticate with Sparkle via browser OAuth |
sparkle setup | Configure supported AI coding tools with Sparkle |
sparkle status | Show login and setup state |
sparkle logout | Sign out or remove config for all IDEs/coding agents or specific one |
sparkle login
Authenticate with Sparkle and store your session locally.~/.sparkle/.
sparkle setup
Wire up supported tools with the Sparkle MCP server, IDE hooks, and guardrail rules. Configure all detected tools:Options
| Option | Description |
|---|---|
--ide <value> | Target a specific IDE. See Supported IDEs. |
sparkle status
Show whether you are logged in and which tools are configured.sparkle logout
Sign out of Sparkle on your machine.Options
| Option | Description |
|---|---|
--ide <value> | Remove config for a specific IDE only |
Supported IDEs/Coding Agents
| Tool | --ide value |
|---|---|
| Cursor | cursor |
| Claude Code | claudeCode |
| Windsurf | windsurf |
| Codex | codex |
Requirements
- Node.js 20+ (for npm install)
- A Sparkle account — sign up for free
Related pages
Install CLI
Install the CLI on your machine.
Using the CLI
Typical CLI workflows and setup.