Documentation

Getting Started

Install EZRA globally

npm install -g ezra-claude-code

Initialize in your project

cd your-project
ezra init

This creates a `.ezra/` directory with default settings.

Run your first scan

ezra scan

View health report

/ezra:health

Getting Started

## Install EZRA globally ```bash npm install -g ezra-claude-code ``` ## Initialize in your project ```bash cd your-project ezra init ``` This creates a `.ezra/` directory with default settings. ## Run your first scan ```bash ezra scan ``` ## View health report ```bash /ezra:health ```

Installation

## Requirements - Node.js 16.7+ - Claude Code ## NPM ```bash npm install -g ezra-claude-code ``` ## VS Code Extension Search **EZRA Governance** in Extensions marketplace. ## Verify ```bash ezra --version # → 6.1.0 ```

Commands Reference

## 41 Slash Commands | Command | Description | |---------|-------------| | `/ezra:init` | Initialize governance | | `/ezra:scan` | Health scan | | `/ezra:guard` | File guard check | | `/ezra:oversight` | Oversight controls | | `/ezra:settings` | Settings management | | `/ezra:compliance` | Compliance checks | | `/ezra:pm` | Project manager | | `/ezra:progress` | Progress dashboard | | `/ezra:library` | Best practices | | `/ezra:agents` | Multi-agent controls | | `/ezra:memory` | Agent memory | | `/ezra:plan` | Planning engine | | `/ezra:workflow` | Workflow templates | | `/ezra:license` | License management | | `/ezra:dash` | Dashboard export | | `/ezra:health` | Health report | | `/ezra:status` | Quick status | | `/ezra:decide` | Record decisions | | `/ezra:review` | Code review | | `/ezra:learn` | Self-learning | | `/ezra:doc` | Document management | | `/ezra:doc-check` | Document gap analysis | | `/ezra:doc-sync` | Document drift detection | | `/ezra:doc-approve` | Document approval | | `/ezra:version` | Version control | | `/ezra:advisor` | Best-practice advisor | | `/ezra:process` | Process engine | | `/ezra:auto` | Autonomous execution | | `/ezra:multi` | Multi-project orchestration | | `/ezra:bootstrap` | Project onboarding | | `/ezra:claude-md` | CLAUDE.md generation | | `/ezra:sync` | AVI-OS sync | | `/ezra:research` | Research agent | | `/ezra:cost` | Cost tracking | | `/ezra:portfolio` | Portfolio view | | `/ezra:handoff` | Session handoff | | `/ezra:interview` | Gap interview engine | | `/ezra:assess` | Readiness assessment | | `/ezra:reconcile` | Plan vs implementation | | `/ezra:help` | Help reference | | `/ezra:install` | Installer |

Configuration

## Settings File All settings in `.ezra/settings.yaml` — 14 sections: - **standards** — Code standards enforcement - **security** — Security scanning rules - **oversight** — Real-time agent oversight - **best_practices** — Best practice library - **workflows** — Workflow templates - **self_learning** — ML-based recommendations - **project_manager** — PM automation - **library** — Practice library config - **agents** — Multi-agent orchestration - **dashboard** — Dashboard export - **memory** — Agent memory system - **planning** — Holistic planning - **licensing** — License tier config - **cloud_sync** — Cloud sync settings

Architecture

## EZRA Architecture ``` 44 hooks (PostToolUse / PreToolUse / SubcommandResult) 41 slash commands 14 settings sections 0 external dependencies ``` **Hooks** intercept Claude Code tool calls. **Commands** provide the slash-command interface. **Settings** persist in YAML. All data lives in the `.ezra/` directory.

Hooks & Agents

## Hook Types - **PreToolUse** — Runs before agent writes - **PostToolUse** — Runs after agent acts - **SubcommandResult** — Handles slash command output ## Multi-Agent Providers Anthropic (Claude), OpenAI (GPT/Codex), Cursor, Windsurf, Ollama, Copilot, Gemini ## Budget Enforcement Daily + monthly limits per agent.

Troubleshooting

## Common Issues **No .ezra directory found** > Run `/ezra:init` first **Permission denied** > Check file permissions on `.ezra/` **Hook not firing** > Verify hooks in Claude Code `settings.json` **Tests failing** ```bash node tests/run-tests.js ``` **License expired** ```bash /ezra:license refresh ```

API Reference

## MCP Server — 26 Tools | Tool | Purpose | |------|--------| | `ezra_settings_read/write` | Settings CRUD | | `ezra_oversight_status/violations` | Oversight data | | `ezra_agent_status/leaderboard` | Agent metrics | | `ezra_cost_summary` | Cost tracking | | `ezra_progress_status` | Progress data | | `ezra_pm_report` | PM reports | | `ezra_library_search` | Library search | | `ezra_memory_facts` | Memory system | | `ezra_workflow_status` | Workflow data | | `ezra_license_status` | License info | All tools read from `.ezra/` directory.