@review-my-code/rmcode 0.1.0-alpha.1 → 0.1.2
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 +29 -0
- package/dist/cli.js +887 -254
- package/package.json +8 -3
package/README.md
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# RMCode CLI
|
|
2
|
+
|
|
3
|
+
Run Review My Code from your terminal.
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
npm install -g @review-my-code/rmcode
|
|
7
|
+
rmcode login
|
|
8
|
+
export RMC_API_KEY=rmc_...
|
|
9
|
+
rmcode --staged
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
The CLI sends the selected diff, file, or stdin content to RMCode for analysis.
|
|
13
|
+
Anonymous CLI reviews are disabled by default, so set `RMC_API_KEY` before
|
|
14
|
+
running a review.
|
|
15
|
+
|
|
16
|
+
## Common Commands
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
rmcode # review branch diff from merge base
|
|
20
|
+
rmcode --staged # review staged changes
|
|
21
|
+
rmcode --unstaged # review unstaged changes
|
|
22
|
+
rmcode --all # review uncommitted tracked changes and safe text files
|
|
23
|
+
rmcode src/auth.ts # review one file
|
|
24
|
+
git diff main | rmcode --lang typescript
|
|
25
|
+
rmcode --json --fail-on-findings
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Use `RMC_API_URL` to point at a non-production API and `RMC_APP_URL` to point
|
|
29
|
+
`rmcode login` at a non-production web app.
|