@codecora/cli 0.0.3 → 0.0.4
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 +6 -57
- package/dist/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,26 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
> AI-powered code review before you commit.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
## ✅ Verified & Tested
|
|
8
|
-
|
|
9
|
-
All CLI features have been tested and verified working:
|
|
10
|
-
|
|
11
|
-
| Feature | Status | Description |
|
|
12
|
-
|---------|--------|-------------|
|
|
13
|
-
| Authentication | ✅ | `cora auth status` shows user info, session validity, expiration |
|
|
14
|
-
| Code Review | ✅ | Reviews staged/unstaged changes with token usage tracking |
|
|
15
|
-
| Output Formats | ✅ | Pretty (default), JSON, Compact formats |
|
|
16
|
-
| Git Hooks | ✅ | Automatic pre-commit review on every commit |
|
|
17
|
-
| Mock Mode | ✅ | Testing without using API credits |
|
|
18
|
-
| Error Handling | ✅ | Graceful handling of network errors and invalid input |
|
|
5
|
+
**Website:** [https://codecora.dev](https://codecora.dev) | **Docs:** [https://codecora.dev/docs/cli](https://codecora.dev/docs/cli)
|
|
19
6
|
|
|
20
|
-
|
|
21
|
-
- Issues with severity (critical, major, minor, info)
|
|
22
|
-
- Token breakdown (input/output/execution time)
|
|
23
|
-
- Quota information
|
|
24
|
-
- AI-generated summaries and suggested fixes
|
|
7
|
+
CORA CLI brings AI code review to your local development workflow. Get instant feedback on your code changes before they leave your machine.
|
|
25
8
|
|
|
26
9
|
## Features
|
|
27
10
|
|
|
@@ -40,25 +23,7 @@ All CLI features have been tested and verified working:
|
|
|
40
23
|
npm install -g @codecora/cli
|
|
41
24
|
|
|
42
25
|
# Using bun
|
|
43
|
-
bun install -g @
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Option 2: Standalone Binary (No Node.js Required)
|
|
47
|
-
|
|
48
|
-
Download the appropriate binary for your platform from the [releases page](https://github.com/ajianaz/cora/releases):
|
|
49
|
-
|
|
50
|
-
| Platform | Download |
|
|
51
|
-
|----------|----------|
|
|
52
|
-
| macOS (Intel) | `cora-macos-x64` |
|
|
53
|
-
| macOS (Apple Silicon) | `cora-macos-arm64` |
|
|
54
|
-
| Linux (x64) | `cora-linux-x64` |
|
|
55
|
-
| Windows (x64) | `cora-win-x64.exe` |
|
|
56
|
-
|
|
57
|
-
```bash
|
|
58
|
-
# Example for macOS
|
|
59
|
-
curl -L https://github.com/ajianaz/cora/releases/latest/download/cora-macos-arm64 -o cora
|
|
60
|
-
chmod +x cora
|
|
61
|
-
sudo mv cora /usr/local/bin/
|
|
26
|
+
bun install -g @codecora/cli
|
|
62
27
|
```
|
|
63
28
|
|
|
64
29
|
## Quick Start
|
|
@@ -92,12 +57,6 @@ cora auth logout
|
|
|
92
57
|
cora auth config [key] [value]
|
|
93
58
|
```
|
|
94
59
|
|
|
95
|
-
**Important:** For CLI authentication to work, you must add `http://localhost:4200/callback` to your GitHub App's redirect URIs:
|
|
96
|
-
|
|
97
|
-
1. Go to your GitHub App settings
|
|
98
|
-
2. Navigate to **General** → **Homepage URL**
|
|
99
|
-
3. Add `http://localhost:4200/callback` to the redirect URIs
|
|
100
|
-
|
|
101
60
|
### Review Code
|
|
102
61
|
|
|
103
62
|
```bash
|
|
@@ -110,9 +69,6 @@ cora review --unstaged
|
|
|
110
69
|
# Review specific files
|
|
111
70
|
cora review --files src/app.ts src/utils.ts
|
|
112
71
|
|
|
113
|
-
# Mock mode for testing
|
|
114
|
-
cora review --mock
|
|
115
|
-
|
|
116
72
|
# JSON output for CI/CD
|
|
117
73
|
cora review --format json
|
|
118
74
|
```
|
|
@@ -144,9 +100,6 @@ cora disable # Uninstall pre-commit hook
|
|
|
144
100
|
| `-s, --staged` | Review staged changes (default) |
|
|
145
101
|
| `-u, --unstaged` | Review unstaged changes |
|
|
146
102
|
| `-f, --files <files...>` | Review specific files |
|
|
147
|
-
| `-m, --max-tokens <number>` | Maximum tokens to use |
|
|
148
|
-
| `-i, --include-walkthrough` | Include full walkthrough |
|
|
149
|
-
| `--mock` | Mock mode for testing |
|
|
150
103
|
| `--format <format>` | Output format (pretty, json, compact) |
|
|
151
104
|
|
|
152
105
|
## Configuration
|
|
@@ -163,7 +116,7 @@ Configuration is stored in `~/.codecora/`:
|
|
|
163
116
|
| `CORA_SKIP` | Skip pre-commit hook when set to 1 |
|
|
164
117
|
| `CORA_SERVER` | Override server URL |
|
|
165
118
|
| `CORA_WORKSPACE` | Override workspace ID |
|
|
166
|
-
| `CORA_API_KEY` | API key for CI/CD authentication
|
|
119
|
+
| `CORA_API_KEY` | API key for CI/CD authentication |
|
|
167
120
|
|
|
168
121
|
## CI/CD Integration
|
|
169
122
|
|
|
@@ -190,8 +143,6 @@ For CI/CD workflows, use API Keys instead of session tokens:
|
|
|
190
143
|
|
|
191
144
|
**Create API Key:** Visit Dashboard → API Keys to generate a key for CI/CD.
|
|
192
145
|
|
|
193
|
-
See [API Keys Documentation](../../../docs/API_KEYS.md) for complete guide.
|
|
194
|
-
|
|
195
146
|
## Troubleshooting
|
|
196
147
|
|
|
197
148
|
### Authentication Errors
|
|
@@ -226,8 +177,7 @@ CORA_SKIP=1 git commit -m "message"
|
|
|
226
177
|
|
|
227
178
|
## Requirements
|
|
228
179
|
|
|
229
|
-
- **Node.js 20+**
|
|
230
|
-
- **OR** standalone binary (no dependencies)
|
|
180
|
+
- **Node.js 20+** or **Bun 1.0+**
|
|
231
181
|
- A Codecora account (sign up at https://codecora.dev)
|
|
232
182
|
- An OpenAI-compatible API key configured in your workspace
|
|
233
183
|
|
|
@@ -238,5 +188,4 @@ MIT © [CORA](https://codecora.dev)
|
|
|
238
188
|
## Support
|
|
239
189
|
|
|
240
190
|
- [Documentation](https://codecora.dev/docs/cli)
|
|
241
|
-
- [
|
|
242
|
-
- [GitHub Discussions](https://github.com/ajianaz/cora/discussions)
|
|
191
|
+
- [Website](https://codecora.dev)
|
package/dist/version.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export const VERSION = '0.0.
|
|
1
|
+
export const VERSION = '0.0.4';
|