@reporails/cli 0.5.6 → 0.5.7
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 +101 -0
- package/package.json +4 -1
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# Reporails CLI (v0.5.7)
|
|
2
|
+
|
|
3
|
+
> **AI Instruction Diagnostics for coding agents. Validates the entire agentic instruction system against 92+ rules across six categories. Supports Claude, Codex, Copilot, Cursor, and Gemini.**
|
|
4
|
+
>
|
|
5
|
+
> *Beta phase - moving fast, feedback welcome.*
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npx @reporails/cli check
|
|
11
|
+
# or
|
|
12
|
+
uvx --from reporails-cli ails check
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
No install, no account. Actionable findings in seconds - fix them, run again, watch the score improve:
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
Reporails - Diagnostics
|
|
19
|
+
|
|
20
|
+
┌─ Main (4) 61 directive / 9 constraint · 71% prose
|
|
21
|
+
│ CLAUDE.md 10 dir / 1 con / 1 amb · 71% prose
|
|
22
|
+
│ Missing tech stack declaration - list languages, frameworks, and runtimes CORE:C:0034
|
|
23
|
+
│ Missing MCP documentation - describe MCP server configuration if applicable CORE:C:0027
|
|
24
|
+
│ ... and 3 more
|
|
25
|
+
│ 4 brief · 1 orphan
|
|
26
|
+
│
|
|
27
|
+
└─ 181 findings
|
|
28
|
+
|
|
29
|
+
[⋯ Agents (3) · Skills (10) · Rules (13) +318 findings ⋯]
|
|
30
|
+
|
|
31
|
+
── Summary ────────────────────────────────────────────────────────
|
|
32
|
+
|
|
33
|
+
Score: 7.3 / 10 ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░ (3.9s)
|
|
34
|
+
Agent: Claude
|
|
35
|
+
|
|
36
|
+
Scope:
|
|
37
|
+
instructions: 277 directive / 448 prose (56%)
|
|
38
|
+
75 constraint / 10 ambiguous
|
|
39
|
+
|
|
40
|
+
Main (4): ▓▓▓▓▓▓▓▓▓▓░░░░░ 6.9 Rules (13): ▓▓▓▓▓▓▓▓▓▓▓▓░░░ 7.9
|
|
41
|
+
Skills (10): ▓▓▓▓▓▓▓▓▓▓▓░░░░ 7.2 Agents (3): ▓▓▓▓▓▓▓▓▓▓░░░░░ 6.9
|
|
42
|
+
|
|
43
|
+
499 findings · 5 errors · 416 warnings · 70 info
|
|
44
|
+
2 cross-file conflicts · 7 cross-file repetitions
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Install permanently
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npx @reporails/cli install
|
|
51
|
+
# or
|
|
52
|
+
uvx --from reporails-cli ails install
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
Puts `ails` on your PATH.
|
|
56
|
+
|
|
57
|
+
## Anonymous vs signed
|
|
58
|
+
|
|
59
|
+
Anonymous mode needs no account. Signing in raises the rate / payload caps and unlocks per-finding fix text and exact cross-file conflict locations.
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
# GitHub Device Flow - authorize in browser
|
|
63
|
+
ails auth login
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
Full breakdown: [Tiers and Limits](https://github.com/reporails/cli/blob/main/docs/tiers.md).
|
|
67
|
+
|
|
68
|
+
## In CI
|
|
69
|
+
|
|
70
|
+
Run on every PR so instruction-quality regressions (contradictions, oversized files, weak reinforcement) get caught the same way test or lint regressions do — before merge, not after a teammate's agent has been silently misbehaving for a week.
|
|
71
|
+
|
|
72
|
+
```yaml
|
|
73
|
+
- uses: reporails/cli/action
|
|
74
|
+
with:
|
|
75
|
+
api-key: ${{ secrets.REPORAILS_API_KEY }} # optional - sign-in for full diagnostic detail
|
|
76
|
+
strict: "true" # exit 1 if any rule fires
|
|
77
|
+
min-score: "7.0" # exit 1 if score < 7.0
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
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).
|
|
81
|
+
|
|
82
|
+
## Documentation
|
|
83
|
+
|
|
84
|
+
- [Getting Started](https://github.com/reporails/cli/blob/main/docs/getting-started.md) - install, first run, what the output means
|
|
85
|
+
- [Agent Support](https://github.com/reporails/cli/blob/main/docs/agent-support.md) - which agents are recognized and what's covered
|
|
86
|
+
- [Tiers and Limits](https://github.com/reporails/cli/blob/main/docs/tiers.md) - anonymous vs signed in, what each mode includes
|
|
87
|
+
- [Configuration](https://github.com/reporails/cli/blob/main/docs/configuration.md) - disabling rules, project / global config, exclude paths
|
|
88
|
+
- [Score Guide](https://github.com/reporails/cli/blob/main/docs/score-guide.md) - how the score is built and what it tells you
|
|
89
|
+
- [FAQ](https://github.com/reporails/cli/blob/main/docs/faq.md) - common questions
|
|
90
|
+
|
|
91
|
+
## Built and validated for
|
|
92
|
+
|
|
93
|
+
- **Claude** — [Anthropic](https://github.com/anthropics)
|
|
94
|
+
- **Codex** — [OpenAI](https://github.com/openai)
|
|
95
|
+
- **Copilot** — [GitHub](https://github.com/github)
|
|
96
|
+
- **Cursor** — [Anysphere](https://github.com/cursor)
|
|
97
|
+
- **Gemini** — [Google](https://github.com/google-gemini)
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
[BUSL 1.1](LICENSE) - converts to Apache 2.0 three years after each release.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@reporails/cli",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.7",
|
|
4
4
|
"description": "AI instruction diagnostics for coding agents",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -14,6 +14,9 @@
|
|
|
14
14
|
"bin/",
|
|
15
15
|
"README.md"
|
|
16
16
|
],
|
|
17
|
+
"scripts": {
|
|
18
|
+
"prepack": "cp ../../README.md ./README.md"
|
|
19
|
+
},
|
|
17
20
|
"keywords": [
|
|
18
21
|
"ai-instructions",
|
|
19
22
|
"claude",
|