@open-code-review/cli 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -33
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,25 +1,23 @@
|
|
|
1
1
|
# @open-code-review/cli
|
|
2
2
|
|
|
3
|
-
The command-line interface for Open Code Review. Handles multi-tool setup and provides real-time progress tracking
|
|
3
|
+
The command-line interface for Open Code Review. Handles multi-tool setup and provides real-time progress tracking.
|
|
4
4
|
|
|
5
5
|
## Why Use the CLI?
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
1. **Multi-tool configuration**: If you use multiple AI assistants (Claude Code, Cursor, Windsurf), the CLI configures all of them with a single command.
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
2. **Progress visibility**: AI-powered reviews take time. The `ocr progress` command shows what's happening in real-time, so you're not staring at a blank screen wondering if anything is working.
|
|
9
|
+
2. **Progress visibility**: AI-powered reviews take time. The `ocr progress` command shows what's happening in real-time.
|
|
12
10
|
|
|
13
11
|
## Installation
|
|
14
12
|
|
|
15
13
|
```bash
|
|
16
|
-
# Global install
|
|
14
|
+
# Global install
|
|
17
15
|
npm install -g @open-code-review/cli
|
|
18
16
|
|
|
19
17
|
# Or via pnpm
|
|
20
18
|
pnpm add -g @open-code-review/cli
|
|
21
19
|
|
|
22
|
-
# Or run directly
|
|
20
|
+
# Or run directly
|
|
23
21
|
npx @open-code-review/cli init
|
|
24
22
|
```
|
|
25
23
|
|
|
@@ -30,10 +28,10 @@ npx @open-code-review/cli init
|
|
|
30
28
|
Initialize Open Code Review in your project.
|
|
31
29
|
|
|
32
30
|
```bash
|
|
33
|
-
# Interactive mode
|
|
31
|
+
# Interactive mode
|
|
34
32
|
ocr init
|
|
35
33
|
|
|
36
|
-
# Non-interactive
|
|
34
|
+
# Non-interactive
|
|
37
35
|
ocr init --tools claude,windsurf,cursor
|
|
38
36
|
|
|
39
37
|
# Configure all detected tools
|
|
@@ -42,9 +40,9 @@ ocr init --tools all
|
|
|
42
40
|
|
|
43
41
|
**What it does:**
|
|
44
42
|
|
|
45
|
-
1. Creates `.ocr/` directory with skills, commands, and
|
|
46
|
-
2. Detects installed AI tools
|
|
47
|
-
3. Configures each tool
|
|
43
|
+
1. Creates `.ocr/` directory with skills, commands, and config
|
|
44
|
+
2. Detects installed AI tools
|
|
45
|
+
3. Configures each tool appropriately
|
|
48
46
|
4. Optionally injects OCR instructions into `AGENTS.md` / `CLAUDE.md`
|
|
49
47
|
|
|
50
48
|
### `ocr progress`
|
|
@@ -52,44 +50,47 @@ ocr init --tools all
|
|
|
52
50
|
Watch a review session in real-time.
|
|
53
51
|
|
|
54
52
|
```bash
|
|
55
|
-
# Auto-detect
|
|
53
|
+
# Auto-detect current session
|
|
56
54
|
ocr progress
|
|
57
55
|
|
|
58
56
|
# Watch a specific session
|
|
59
57
|
ocr progress --session 2026-01-26-feature-auth
|
|
60
58
|
```
|
|
61
59
|
|
|
62
|
-
|
|
60
|
+
Shows: current phase, elapsed time, reviewer status, finding counts, completion percentage.
|
|
63
61
|
|
|
64
|
-
|
|
65
|
-
- Individual reviewer status
|
|
66
|
-
- Finding counts as they're discovered
|
|
67
|
-
- Overall completion percentage
|
|
62
|
+
### `ocr update`
|
|
68
63
|
|
|
69
|
-
|
|
64
|
+
Update OCR skills and commands to the latest version.
|
|
70
65
|
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
| Windsurf | `.windsurf/` | Auto-detected |
|
|
75
|
-
| Cursor | `.cursor/` | Auto-detected |
|
|
76
|
-
| GitHub Copilot | `.github/` | Auto-detected |
|
|
77
|
-
| Cline | `.cline/` | Auto-detected |
|
|
78
|
-
| Continue | `.continue/` | Auto-detected |
|
|
66
|
+
```bash
|
|
67
|
+
ocr update
|
|
68
|
+
```
|
|
79
69
|
|
|
80
|
-
|
|
70
|
+
## Supported AI Tools
|
|
71
|
+
|
|
72
|
+
| Tool | Config Directory |
|
|
73
|
+
|------|------------------|
|
|
74
|
+
| Claude Code | `.claude/` |
|
|
75
|
+
| Windsurf | `.windsurf/` |
|
|
76
|
+
| Cursor | `.cursor/` |
|
|
77
|
+
| GitHub Copilot | `.github/` |
|
|
78
|
+
| Cline | `.cline/` |
|
|
79
|
+
| Continue | `.continue/` |
|
|
81
80
|
|
|
82
81
|
## After Installation
|
|
83
82
|
|
|
84
|
-
|
|
83
|
+
Use OCR through your AI assistant:
|
|
85
84
|
|
|
86
85
|
```
|
|
87
|
-
/ocr-review
|
|
88
|
-
/ocr-
|
|
89
|
-
/ocr-
|
|
86
|
+
/ocr-review # Start a code review
|
|
87
|
+
/ocr-review against spec.md # Review against a spec file
|
|
88
|
+
/ocr-doctor # Verify setup
|
|
90
89
|
```
|
|
91
90
|
|
|
92
|
-
|
|
91
|
+
For Claude Code / Cursor, use `/ocr:review`, `/ocr:doctor`, etc.
|
|
92
|
+
|
|
93
|
+
See the [main README](https://github.com/spencermarx/open-code-review) for full documentation.
|
|
93
94
|
|
|
94
95
|
## License
|
|
95
96
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@open-code-review/cli",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.1",
|
|
4
4
|
"description": "CLI for Open Code Review - Multi-environment setup and progress tracking",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"commander": "^13.0.0",
|
|
35
35
|
"log-update": "^7.0.2",
|
|
36
36
|
"ora": "^8.1.1",
|
|
37
|
-
"@open-code-review/agents": "1.1.
|
|
37
|
+
"@open-code-review/agents": "1.1.1"
|
|
38
38
|
},
|
|
39
39
|
"publishConfig": {
|
|
40
40
|
"access": "public"
|