Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@open-code-review/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@open-code-review/cli
The command-line interface for Open Code Review. Handles multi-tool setup and provides real-time progress tracking.
Why Use the CLI?
Multi-tool configuration: If you use multiple AI assistants (Claude Code, Cursor, Windsurf), the CLI configures all of them with a single command.
Progress visibility: AI-powered reviews take time. The
ocr progresscommand shows what's happening in real-time.
Installation
# Global install
npm install -g @open-code-review/cli
# Or via pnpm
pnpm add -g @open-code-review/cli
# Or run directly
npx @open-code-review/cli initCommands
ocr init
Initialize Open Code Review in your project.
# Interactive mode
ocr init
# Non-interactive
ocr init --tools claude,windsurf,cursor
# Configure all detected tools
ocr init --tools allWhat it does:
- Creates
.ocr/directory with skills, commands, and config - Detects installed AI tools
- Configures each tool appropriately
- Optionally injects OCR instructions into
AGENTS.md/CLAUDE.md
ocr progress
Watch a review session in real-time.
# Auto-detect current session
ocr progress
# Watch a specific session
ocr progress --session 2026-01-26-feature-authShows: current phase, elapsed time, reviewer status, finding counts, completion percentage, and current round.
Multi-round support: The progress display shows which round is active and tracks completion across rounds. When a round completes, running /ocr-review again starts a new round (round-2/, round-3/, etc.).
ocr update
Update OCR skills and commands to the latest version after upgrading the package.
# Update everything
ocr update
# Preview changes first
ocr update --dry-run
# Update specific components
ocr update --commands # Commands only
ocr update --skills # Skills and references only
ocr update --inject # AGENTS.md/CLAUDE.md onlyWhat it does:
- Detects which AI tools you configured during
ocr init - Updates
.ocr/skills/(SKILL.md, workflow, discourse rules) - Updates tool-specific commands (
.windsurf/workflows/, etc.) - Updates managed blocks in
AGENTS.md/CLAUDE.md
What is NOT modified:
.ocr/config.yaml— Your team composition and context are preserved.ocr/skills/references/reviewers/— All reviewers preserved (default and custom).ocr/sessions/— Review history remains untouched
Session Storage
The CLI reads session state from .ocr/sessions/{date}-{branch}/:
.ocr/sessions/2026-01-26-feature-auth/
├── state.json # Workflow state (read by progress command)
└── rounds/
├── round-1/
│ ├── reviews/*.md # Individual reviewer outputs
│ ├── discourse.md
│ └── final.md # Completion indicator
└── round-2/ # Additional rounds if re-reviewedThe CLI derives round information from the filesystem:
- Round count: Enumerated from
rounds/round-*/directories - Round completion: Determined by
final.mdpresence - Reviewer progress: Listed from
rounds/round-{n}/reviews/*.md
Supported AI Tools
| Tool | Config Directory |
|---|---|
| Claude Code | .claude/ |
| Windsurf | .windsurf/ |
| Cursor | .cursor/ |
| GitHub Copilot | .github/ |
| Cline | .cline/ |
| Continue | .continue/ |
After Installation
Use OCR through your AI assistant:
/ocr-review # Start a code review
/ocr-review against spec.md # Review against a spec file
/ocr-doctor # Verify setupFor Claude Code / Cursor, use /ocr:review, /ocr:doctor, etc.
See the main README for full documentation.
License
Apache-2.0