@reporails/cli 0.5.0 → 0.5.1
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 +41 -45
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# @reporails/cli
|
|
2
2
|
|
|
3
|
-
AI
|
|
3
|
+
AI Instruction Diagnostics for coding agents. Validates the entire agentic instruction system against 90+ rules.
|
|
4
4
|
|
|
5
|
-
### Beta —
|
|
5
|
+
### Beta — first 100 users free.
|
|
6
6
|
|
|
7
7
|
## Quick Start
|
|
8
8
|
|
|
@@ -10,24 +10,22 @@ AI instruction diagnostics for coding agents. Validates instruction files for Cl
|
|
|
10
10
|
npx @reporails/cli check
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
No install, no account. Actionable findings in seconds:
|
|
14
14
|
|
|
15
15
|
```
|
|
16
16
|
Reporails — Diagnostics
|
|
17
17
|
|
|
18
18
|
┌─ Main (1)
|
|
19
|
-
│ CLAUDE.md
|
|
20
|
-
│ ⚠
|
|
21
|
-
│
|
|
19
|
+
│ CLAUDE.md 4 dir / 3 con · 73% prose
|
|
20
|
+
│ ⚠ Missing tech stack declaration CORE:C:0034
|
|
21
|
+
│ ⚠ Missing testing documentation CORE:C:0005
|
|
22
|
+
│ 2 brief · 2 orphan
|
|
22
23
|
│
|
|
23
|
-
└─
|
|
24
|
+
└─ 10 findings
|
|
24
25
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
Agent: Claude
|
|
29
|
-
|
|
30
|
-
3 findings · 0 errors · 2 warnings · 1 info
|
|
26
|
+
Score: 7.4 / 10 ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░ (1.2s)
|
|
27
|
+
10 findings · 8 warnings · 2 info
|
|
28
|
+
Compliance: HIGH
|
|
31
29
|
```
|
|
32
30
|
|
|
33
31
|
## Install
|
|
@@ -44,53 +42,51 @@ Once installed globally, use `ails` directly:
|
|
|
44
42
|
|
|
45
43
|
```bash
|
|
46
44
|
ails check
|
|
47
|
-
ails auth login # Unlock
|
|
45
|
+
ails auth login # Unlock full diagnostics (GitHub sign-in)
|
|
48
46
|
ails check # Now with cross-file analysis + compliance scoring
|
|
49
47
|
```
|
|
50
48
|
|
|
51
49
|
## Supported Agents
|
|
52
50
|
|
|
53
|
-
| Agent
|
|
54
|
-
|
|
55
|
-
| Claude
|
|
56
|
-
| Codex
|
|
57
|
-
| Copilot |
|
|
58
|
-
| Gemini
|
|
59
|
-
| Cursor
|
|
51
|
+
| Agent | Instruction files |
|
|
52
|
+
|---------|-----------------------------------------------------------|
|
|
53
|
+
| Claude | `CLAUDE.md`, `.claude/rules/*.md`, `.claude/skills/*/SKILL.md` |
|
|
54
|
+
| Codex | `AGENTS.md`, `CODEX.md`, `agents/*.md` |
|
|
55
|
+
| Copilot | `.github/copilot-instructions.md` |
|
|
56
|
+
| Gemini | `GEMINI.md`, `.gemini/rules/*.md` |
|
|
57
|
+
| Cursor | `.cursorrules`, `.cursor/rules/*.md` |
|
|
60
58
|
|
|
61
59
|
## Commands
|
|
62
60
|
|
|
63
|
-
| Command
|
|
64
|
-
|
|
65
|
-
| `check [PATH]`
|
|
66
|
-
| `explain RULE_ID`
|
|
67
|
-
| `heal`
|
|
68
|
-
| `auth login`
|
|
69
|
-
| `auth status`
|
|
70
|
-
| `auth logout`
|
|
71
|
-
| `install [PATH]`
|
|
72
|
-
| `version`
|
|
61
|
+
| Command | Description |
|
|
62
|
+
|----------------------|--------------------------------------------|
|
|
63
|
+
| `check [PATH]` | Validate instruction files (90+ rules) |
|
|
64
|
+
| `explain RULE_ID` | Show rule details and fix guidance |
|
|
65
|
+
| `heal` | Auto-fix common violations |
|
|
66
|
+
| `auth login` | Sign in with GitHub |
|
|
67
|
+
| `auth status` | Check auth state |
|
|
68
|
+
| `auth logout` | Remove stored credentials |
|
|
69
|
+
| `install [PATH]` | Install MCP server for detected agents |
|
|
70
|
+
| `version` | Show version info |
|
|
73
71
|
|
|
74
72
|
## What It Checks
|
|
75
73
|
|
|
76
|
-
90+ rules across
|
|
74
|
+
90+ rules across five categories:
|
|
77
75
|
|
|
78
|
-
- **Structure** — File organization, size limits, modularity
|
|
79
|
-
- **Content** — Specificity, reinforcement,
|
|
80
|
-
- **
|
|
81
|
-
- **Efficiency** — Token usage, import depth, elaboration
|
|
76
|
+
- **Structure** — File organization, size limits, modularity
|
|
77
|
+
- **Content** — Specificity, reinforcement, tech stack, domain terminology
|
|
78
|
+
- **Efficiency** — Token usage, elaboration, formatting
|
|
82
79
|
- **Maintenance** — Versioning, review processes
|
|
83
80
|
- **Governance** — Security policies, credential protection
|
|
84
81
|
|
|
85
|
-
##
|
|
82
|
+
## Offline vs Authenticated
|
|
86
83
|
|
|
87
|
-
| Feature
|
|
88
|
-
|
|
89
|
-
| Mechanical
|
|
90
|
-
|
|
|
91
|
-
| Cross-file analysis
|
|
92
|
-
|
|
|
93
|
-
| Compliance scoring | — | Per-instruction strength |
|
|
84
|
+
| Feature | Offline | Authenticated |
|
|
85
|
+
|----------------------|-------------|------------------------------|
|
|
86
|
+
| Mechanical checks | 70+ rules | 70+ rules |
|
|
87
|
+
| Content checks | 25+ rules | 25+ rules |
|
|
88
|
+
| Cross-file analysis | — | Conflicts, repetition |
|
|
89
|
+
| Compliance scoring | — | Per-instruction strength |
|
|
94
90
|
|
|
95
91
|
## GitHub Actions
|
|
96
92
|
|
|
@@ -109,7 +105,7 @@ jobs:
|
|
|
109
105
|
|
|
110
106
|
## How It Works
|
|
111
107
|
|
|
112
|
-
Thin Node.js wrapper around
|
|
108
|
+
Thin Node.js wrapper around [reporails-cli](https://pypi.org/project/reporails-cli/). Commands proxied via `uvx` — no Python install required. Node.js >= 18 needed. `uv` auto-installed if missing.
|
|
113
109
|
|
|
114
110
|
## License
|
|
115
111
|
|