@sparkle-security/sparkle-cli
v0.1.0
Published
Sparkle Guardrails CLI (login, setup, hooks handler)
Readme
Sparkle Code CLI – Security Guardrails for AI-assisted coding
Command-line tool for Sparkle Guardrails — security and compliance guardrails directly injected into AI-assisted coding, where code is actually written.
The CLI authenticates with Sparkle, configures your AI coding tools, and runs as a hook handler so guardrails are applied on every prompt and tool use.
Why developers 💜 Sparkle Security
- No time-consuming rework: Sparkle stops risky AI-generated code at the moment it's written — before it becomes a PR comment, a scanner alert, or a 2am Slack message.
- Keep the tools and processes that already work for you: Sparkle embeds silently into your AI coding tools, so you keep the same flow and speed with no re-setup exercise.
- Security & compliance from day 1: Bake in standards like OWASP, plus custom org policies, from the very first commit.
Install
npm (requires Node.js 20+):
npm install -g @sparkle-security/sparkle-cliQuick start
sparkle login # Sign in (opens your browser)
sparkle setup # Configure all supported ides
sparkle status # Check login and setup stateTo configure a specific tool:
sparkle setup --ide cursorWhat it does
sparkle login— Authenticate with Sparkle via browser OAuth and store your session locally.sparkle setup— Wire up supported tools with the Sparkle MCP server, IDE hooks, and guardrail rules. Auto-detects installed tools, or target one with--ide.sparkle status— Show whether you are logged in and which tools are configured.sparkle logout— Sign out machine-wide, or remove config for one tool with--ide.sparkle-hooks— Hook handler invoked by your IDE on prompts, MCP calls, file edits, and session events. Runs silently as a telemetry sidecar; installed and wired up for you bysparkle setup.
Shared state lives under ~/.sparkle/.
Supported IDEs
| Tool | --ide value |
| --- | --- |
| Cursor | cursor |
| Claude Code | claudeCode |
| Windsurf | windsurf |
| Codex CLI | codex |
You can also use the Sparkle Guardrails extension for VS Code, Cursor, and Windsurf — it bundles this CLI and delegates setup to it.
Docs & sign up
- Sign up: app.thesparkle.ai
- Website: thesparkle.ai
Requirements
- Node.js 20+ (npm install only)
- A Sparkle account (free sign-up)
License
Proprietary — see thesparkle.ai for terms.
