Skip to main content
Reference for all Sparkle CLI commands, options, and supported IDE values.

​
Command overview

​
sparkle login

Authenticate with Sparkle and store your session locally.
Opens your browser to complete OAuth sign-in. Session data is saved under ~/.sparkle/.

​
sparkle setup

Wire up supported tools with the Sparkle MCP server, IDE hooks, and guardrail rules. Configure all detected tools:
Configure a specific tool:

​
Options

​
sparkle status

Show whether you are logged in and which tools are configured.

​
sparkle logout

Sign out of Sparkle on your machine.
Remove Sparkle configuration for one tool:

​
Options

​
Supported IDEs/Coding Agents

​
Requirements

Install CLI

Install the CLI on your machine.

Using the CLI

Typical CLI workflows and setup.