Skip to main content
The Sparkle CLI authenticates with Sparkle, configures your AI coding tools, and runs as a hook handler so guardrails apply on every prompt and tool use.

​
Prerequisites

Before you install, make sure you have:
  • Node.js 20+ — required for the npm install
  • A Sparkle account — sign up for free

​
Install

Install the CLI globally with npm: 
npm install -g @sparkle-security/sparkle-cli

​
Verify installation

Confirm the CLI is available: 
sparkle --help
You should see the list of available commands.

​
Next steps

After installation, sign in and configure your tools:
1

Sign in

sparkle login
This opens your browser to authenticate with Sparkle and stores your session locally.
2

Configure your tools

sparkle setup
This wires up supported IDEs/Coding Agents with the Sparkle MCP server, hooks, and guardrail rules.
3

Check status

sparkle status
Confirm you are logged in and see which tools are configured.

Using the CLI

Learn the full CLI workflow.