@reporails/cli 0.5.9 → 0.5.11
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 +22 -19
- package/bin/reporails.mjs +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# Reporails CLI (v0.5.
|
|
1
|
+
# Reporails CLI (v0.5.11)
|
|
2
2
|
|
|
3
3
|
> **AI Instruction Diagnostics for coding agents. Validates the entire agentic instruction system against 120+ rules across six rule packs (core + per-agent). Supports Claude, Codex, Copilot, Cursor, and Gemini.**
|
|
4
4
|
>
|
|
@@ -12,36 +12,37 @@ npx @reporails/cli check
|
|
|
12
12
|
uvx --from reporails-cli ails check
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
No install, no account.
|
|
15
|
+
No install, no account. The headline is a single **Quality** score (the analysis service's verdict on how well-formed your instructions are); fix the findings that move it, run again, watch it climb:
|
|
16
16
|
|
|
17
17
|
```
|
|
18
|
-
Reporails
|
|
18
|
+
Reporails — Diagnostics
|
|
19
19
|
|
|
20
|
-
┌─ Main (
|
|
20
|
+
┌─ Main (1) 10 directive / 1 constraint · 71% prose
|
|
21
21
|
│ CLAUDE.md 10 dir / 1 con / 1 amb · 71% prose
|
|
22
|
-
│
|
|
23
|
-
│
|
|
24
|
-
│
|
|
25
|
-
│
|
|
22
|
+
│ ✗ Missing tech stack declaration — list languages, frameworks, runtimes CORE:C:0034
|
|
23
|
+
│ → Name the languages, frameworks, and runtimes the project targets.
|
|
24
|
+
│ ⚠ 'pytest' should be in backticks (×3) CORE:E:0003
|
|
25
|
+
│ → Wrap in backticks: `pytest`
|
|
26
|
+
│ ◦ +4 lower-priority (won't move your score yet) · -v to list
|
|
27
|
+
│ ⊕ 6 Pro diagnostics (1 error) — isolated instructions, buried directives
|
|
26
28
|
│
|
|
27
|
-
└─
|
|
28
|
-
|
|
29
|
-
[⋯ Agents (3) · Skills (10) · Rules (13) +318 findings ⋯]
|
|
29
|
+
└─ 12 findings
|
|
30
30
|
|
|
31
31
|
── Summary ────────────────────────────────────────────────────────
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
Quality 6.4 / 10 ▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░ (4.1s)
|
|
34
|
+
Findings 3 errors · 38 warnings · 12 info
|
|
34
35
|
Agent: Claude
|
|
36
|
+
Level: L4 Delegated
|
|
35
37
|
|
|
36
38
|
Scope:
|
|
37
|
-
instructions:
|
|
38
|
-
|
|
39
|
+
instructions: 64 directive / 102 prose (61%)
|
|
40
|
+
18 constraint / 4 ambiguous
|
|
39
41
|
|
|
40
|
-
Main (
|
|
41
|
-
Skills (
|
|
42
|
+
Main (1): ▓▓▓▓▓▓▓▓▓░░░░░░ 6.4 1 err Rules (2): ▓▓▓▓▓▓▓▓▓▓▓▓░░░ 7.9
|
|
43
|
+
Skills (3): ▓▓▓▓▓▓▓▓▓▓▓░░░░ 7.2 Agents (1): ▓▓▓▓▓▓▓▓▓▓░░░░░ 6.6
|
|
42
44
|
|
|
43
|
-
|
|
44
|
-
2 cross-file conflicts · 7 cross-file repetitions
|
|
45
|
+
+ 41 Pro diagnostics (1 error · 32 warnings) — sign in for line numbers + fix coordinates
|
|
45
46
|
```
|
|
46
47
|
|
|
47
48
|
## Install permanently
|
|
@@ -74,7 +75,7 @@ Run on every PR so instruction-quality regressions (contradictions, oversized fi
|
|
|
74
75
|
with:
|
|
75
76
|
api-key: ${{ secrets.REPORAILS_API_KEY }} # optional - sign-in for full diagnostic detail
|
|
76
77
|
strict: "true" # exit 1 if any rule fires
|
|
77
|
-
min-score: "7.0" # exit 1 if
|
|
78
|
+
min-score: "7.0" # exit 1 if Quality < 7.0
|
|
78
79
|
```
|
|
79
80
|
|
|
80
81
|
Capture your API key with `ails auth token` and store it as `REPORAILS_API_KEY` in your CI secret store. See [Configuration → Authentication](https://github.com/reporails/cli/blob/main/docs/configuration.md#authentication).
|
|
@@ -86,6 +87,8 @@ Capture your API key with `ails auth token` and store it as `REPORAILS_API_KEY`
|
|
|
86
87
|
- [Tiers and Limits](https://github.com/reporails/cli/blob/main/docs/tiers.md) - anonymous vs signed in, what each mode includes
|
|
87
88
|
- [Configuration](https://github.com/reporails/cli/blob/main/docs/configuration.md) - disabling rules, project / global config, exclude paths
|
|
88
89
|
- [Score Guide](https://github.com/reporails/cli/blob/main/docs/score-guide.md) - how the score is built and what it tells you
|
|
90
|
+
- [Capability Levels](https://github.com/reporails/cli/blob/main/docs/capability-levels.md) - the L0-L7 ladder and what each level requires
|
|
91
|
+
- [Rules CLI](https://github.com/reporails/cli/blob/main/docs/rules-cli.md) - `ails rules list --capability=skill` and friends — preflight rules before authoring
|
|
89
92
|
- [FAQ](https://github.com/reporails/cli/blob/main/docs/faq.md) - common questions
|
|
90
93
|
|
|
91
94
|
## Built and validated for
|
package/bin/reporails.mjs
CHANGED
|
@@ -80,7 +80,7 @@ function ensureUv() {
|
|
|
80
80
|
function proxy(args) {
|
|
81
81
|
ensureUv();
|
|
82
82
|
|
|
83
|
-
const child = spawn("uvx", ["--refresh", "--from", PYPI_PACKAGE, CLI_COMMAND, ...args], {
|
|
83
|
+
const child = spawn("uvx", ["--refresh-package", PYPI_PACKAGE, "--from", PYPI_PACKAGE, CLI_COMMAND, ...args], {
|
|
84
84
|
stdio: "inherit",
|
|
85
85
|
});
|
|
86
86
|
|