CLI
The ritual CLI installs the workflow skills your coding agent uses to call Ritual. Works with Claude Code, Cursor, Kiro, Codex, GitHub Copilot, Gemini CLI, and Windsurf.
Install
npm install -g @ritual-ai/cli
That gives you the ritual binary plus the skill files for every supported coding agent.
Quickstart
# Inside your project
ritual init # scaffold skills into .claude/, .cursor/, etc.
ritual login # authenticate to Ritual Cloud (optional)
Then in your coding agent:
/ritual explore "Add multi-tenant RBAC"
/ritual brief
/ritual build "Add notification preferences"
See the full slash commands reference.
Two modes
Ritual auto-detects whether you’re signed in and picks the right depth.
| Light mode | Cloud mode | |
|---|---|---|
| Setup | ritual init | ritual init + ritual login |
| Auth | None | Free Ritual Cloud account |
| Discovery questions | Local — saved to RITUAL.md | Generated by AI pipeline, reviewed in app.ritual.work |
| Knowledge sources | Local files | Uploaded and indexed for cross-exploration retrieval |
| Recommendations | Inferred locally from codebase + RITUAL.md | Synthesized via the agentic pipeline |
| Build Brief | Generated from RITUAL.md | Generated from accepted recommendations + requirement packages |
| Collaboration | Solo only | Invite teammates to answer blocking questions |
Both modes work in any supported coding agent. Light mode is right for solo work or evaluating Ritual without an account. Cloud mode unlocks team collaboration and the full agentic pipeline.
Related
- Slash commands
- MCP server — how Cloud mode connects to your editor.
- API keys & scopes