@reporails/cli 0.3.0 → 0.4.0
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 +15 -32
- package/bin/reporails.mjs +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ Score your CLAUDE.md files. See what's missing. Improve your AI coding setup.
|
|
|
5
5
|
## Quick Start
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
-
npx @reporails/cli
|
|
8
|
+
npx @reporails/cli install
|
|
9
9
|
```
|
|
10
10
|
|
|
11
11
|
This detects agents in your project and writes the MCP config. Then ask Claude:
|
|
@@ -23,7 +23,7 @@ npx @reporails/cli check
|
|
|
23
23
|
That's it. You'll get a score, capability level, and actionable violations.
|
|
24
24
|
```
|
|
25
25
|
╔══════════════════════════════════════════════════════════════╗
|
|
26
|
-
║ SCORE: 8.1 / 10 (
|
|
26
|
+
║ SCORE: 8.1 / 10 (awaiting semantic) | CAPABILITY: Maintained (L5) ║
|
|
27
27
|
║ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░ ║
|
|
28
28
|
╚══════════════════════════════════════════════════════════════╝
|
|
29
29
|
|
|
@@ -94,42 +94,24 @@ See the [main README](https://github.com/reporails/cli#github-actions) for full
|
|
|
94
94
|
|
|
95
95
|
## Commands
|
|
96
96
|
|
|
97
|
-
```bash
|
|
98
|
-
ails setup # Set up MCP server for detected agents
|
|
99
|
-
ails check # Score your setup
|
|
100
|
-
ails check -f json # JSON output (for CI)
|
|
101
|
-
ails check -f github # GitHub Actions annotations
|
|
102
|
-
ails check --strict # Exit 1 if violations (for CI)
|
|
103
|
-
ails check --no-update-check # Skip pre-run update prompt
|
|
104
|
-
ails check --exclude-dir vendor # Exclude directory from scanning
|
|
105
|
-
ails check -v # Verbose: per-file PASS/FAIL with rule titles
|
|
106
|
-
ails heal # Interactive auto-fix + semantic evaluation
|
|
107
|
-
ails heal --non-interactive # JSON output for agents and scripts
|
|
108
|
-
ails explain CORE:S:0001 # Explain a rule
|
|
109
|
-
ails map # Show project structure
|
|
110
|
-
ails map --save # Generate backbone.yml
|
|
111
|
-
ails update # Update rules framework + recommended
|
|
112
|
-
ails update --check # Check for updates without installing
|
|
113
|
-
ails update --recommended # Update recommended rules only
|
|
114
|
-
ails update --force # Force reinstall even if current
|
|
115
|
-
ails update --cli # Upgrade the CLI package itself
|
|
116
|
-
ails dismiss CORE:C:0001 # Dismiss a semantic finding
|
|
117
|
-
ails judge . "RULE:FILE:pass:reason" # Cache semantic verdicts
|
|
118
|
-
ails version # Show version info
|
|
119
|
-
```
|
|
120
|
-
|
|
121
97
|
| Command | Description |
|
|
122
98
|
|---------|-------------|
|
|
123
|
-
| `
|
|
99
|
+
| `install [PATH]` | Install MCP server for detected agents |
|
|
124
100
|
| `check [PATH]` | Validate instruction files |
|
|
125
101
|
| `heal [PATH]` | Interactive auto-fix + semantic evaluation |
|
|
126
102
|
| `explain RULE_ID` | Show rule details |
|
|
127
103
|
| `map [PATH]` | Discover project structure |
|
|
128
104
|
| `update` | Update rules framework + recommended |
|
|
105
|
+
| `config set KEY VALUE` | Set a project config value |
|
|
106
|
+
| `config set --global KEY VALUE` | Set a global default |
|
|
107
|
+
| `config get KEY` | Show a config value |
|
|
108
|
+
| `config list` | Show all config (project + global) |
|
|
129
109
|
| `dismiss RULE_ID` | Dismiss a semantic finding |
|
|
130
110
|
| `judge PATH VERDICTS` | Cache semantic verdicts |
|
|
131
111
|
| `version` | Show version info |
|
|
132
112
|
|
|
113
|
+
See the [main README](https://github.com/reporails/cli#commands) for full flag reference.
|
|
114
|
+
|
|
133
115
|
## Updating
|
|
134
116
|
|
|
135
117
|
```bash
|
|
@@ -147,10 +129,11 @@ Persistent installs: `npm install -g @reporails/cli@latest`
|
|
|
147
129
|
|
|
148
130
|
## Recommended Rules
|
|
149
131
|
|
|
150
|
-
[Recommended rules](https://github.com/reporails/recommended) (AILS_ namespace) are included by default and auto-downloaded on first run. To opt out
|
|
132
|
+
[Recommended rules](https://github.com/reporails/recommended) (AILS_ namespace) are included by default and auto-downloaded on first run. To opt out:
|
|
151
133
|
|
|
152
|
-
```
|
|
153
|
-
recommended
|
|
134
|
+
```bash
|
|
135
|
+
ails config set recommended false # This project only
|
|
136
|
+
ails config set --global recommended false # All projects
|
|
154
137
|
```
|
|
155
138
|
|
|
156
139
|
To update recommended rules independently:
|
|
@@ -163,7 +146,7 @@ ails update --recommended
|
|
|
163
146
|
|
|
164
147
|
- **Node.js >= 18**
|
|
165
148
|
- **uv** — auto-installed if missing ([manual install](https://docs.astral.sh/uv/))
|
|
166
|
-
- **No additional dependencies** — `
|
|
149
|
+
- **No additional dependencies** — `install` writes config files directly
|
|
167
150
|
|
|
168
151
|
## How It Works
|
|
169
152
|
|
|
@@ -178,4 +161,4 @@ Want to add or improve rules? Please follow [Contribute](https://github.com/repo
|
|
|
178
161
|
|
|
179
162
|
## License
|
|
180
163
|
|
|
181
|
-
BUSL 1.1
|
|
164
|
+
BUSL 1.1 — converts to Apache 2.0 on 2029-02-20 or at 1.0, whichever comes first.
|
package/bin/reporails.mjs
CHANGED
|
@@ -11,7 +11,7 @@ const HELP = `
|
|
|
11
11
|
reporails — Score your CLAUDE.md files
|
|
12
12
|
|
|
13
13
|
Usage:
|
|
14
|
-
reporails
|
|
14
|
+
reporails install [PATH] Install MCP server for detected agents
|
|
15
15
|
reporails check [PATH] [OPTIONS] Validate instruction files
|
|
16
16
|
reporails explain RULE_ID Show rule details
|
|
17
17
|
reporails map [PATH] [--save] Discover project structure
|
|
@@ -24,7 +24,7 @@ Usage:
|
|
|
24
24
|
reporails <command> [args...] Proxy any command to ails CLI
|
|
25
25
|
|
|
26
26
|
Examples:
|
|
27
|
-
npx @reporails/cli
|
|
27
|
+
npx @reporails/cli install # Install MCP server
|
|
28
28
|
npx @reporails/cli check # Score your setup
|
|
29
29
|
npx @reporails/cli explain CORE:S:0001 # Explain a rule
|
|
30
30
|
npx @reporails/cli update # Update rules + recommended
|