Prerequisites
Before you set up Codex, make sure you have:- Codex installed on your machine
- Node.js 20+ required for the CLI install
- A Sparkle account, sign up for free
- The Sparkle CLI installed, see Install CLI
Set up Codex
1
Sign in
Authenticate with Sparkle via browser OAuth:Your session is stored locally under
~/.sparkle/.2
Configure Codex
Wire Codex to Sparkle:This connects Codex to the Sparkle MCP server, installs IDE hooks, and registers guardrail rules for your workspace.
3
Verify status
Confirm you are logged in and Codex is configured:
Verify guardrails
1
Open a project
Open the repository you want to protect with Sparkle in Codex.
2
Run a prompt
Use Codex in that project. Sparkle applies guardrails on every prompt and tool use.
What setup configures
When you runsparkle setup --ide codex, the CLI:
- Connects Codex to the Sparkle MCP server
- Installs and wires up IDE hooks
- Registers guardrail rules for your workspace
Remove configuration
To remove Sparkle configuration from Codex only:Next steps
Using the CLI
Learn the full CLI workflow.
Commands
Full command reference with options.