@reporails/cli 0.5.4 → 0.5.6
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/package.json +1 -1
- package/README.md +0 -121
package/package.json
CHANGED
package/README.md
DELETED
|
@@ -1,121 +0,0 @@
|
|
|
1
|
-
# @reporails/cli
|
|
2
|
-
|
|
3
|
-
AI Instruction Diagnostics for coding agents. Validates the entire agentic instruction system against 97 rules.
|
|
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:
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
Reporails — Diagnostics — Pro (beta)
|
|
19
|
-
|
|
20
|
-
┌─ Main (1)
|
|
21
|
-
│ CLAUDE.md
|
|
22
|
-
│ ⚠ Missing directory layout — show the project … CORE:C:0035
|
|
23
|
-
│ ⚠ L9 7 of 7 instruction(s) lack effective reinfor… CORE:C:0053
|
|
24
|
-
│ ... and 16 more
|
|
25
|
-
│ 1 misordered · 1 orphan · 1 ambiguous
|
|
26
|
-
│
|
|
27
|
-
└─ 21 findings
|
|
28
|
-
|
|
29
|
-
Score: 7.9 / 10 ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░ (1.3s)
|
|
30
|
-
21 findings · 4 warnings · 1 info
|
|
31
|
-
Compliance: HIGH
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## Install
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
# One-shot (no install needed)
|
|
38
|
-
npx @reporails/cli check
|
|
39
|
-
|
|
40
|
-
# Permanent install (puts ails on PATH + configures MCP)
|
|
41
|
-
npx @reporails/cli install
|
|
42
|
-
# or
|
|
43
|
-
uvx --from reporails-cli ails install
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
Once installed, use `ails` directly:
|
|
47
|
-
|
|
48
|
-
```bash
|
|
49
|
-
ails check # Validate instruction files
|
|
50
|
-
ails update # Upgrade to latest version
|
|
51
|
-
ails auth login # Unlock full diagnostics (GitHub sign-in)
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
## Supported Agents
|
|
55
|
-
|
|
56
|
-
| Agent | Base config | Rules | Skills | Agents | Other |
|
|
57
|
-
|-------|-------------|-------|--------|--------|-------|
|
|
58
|
-
| Claude | `CLAUDE.md`, `.local.md` | `.claude/rules/**/*.md` | `.claude/skills/**/SKILL.md` | `.claude/agents/**/*.md` | commands, output-styles, memory, MCP, settings |
|
|
59
|
-
| Codex | `AGENTS.md`, `.override.md` | `.codex/rules/*.rules` | `.agents/skills/**/SKILL.md` | `.codex/agents/*.toml` | hooks, config |
|
|
60
|
-
| Copilot | `.github/copilot-instructions.md` | `.github/instructions/**/*.md` | `.github/skills/**/SKILL.md` | `.github/agents/*.agent.md` | hooks, prompts, MCP |
|
|
61
|
-
| Cursor | `.cursorrules`, `AGENTS.md` | `.cursor/rules/**/*.mdc` | `.cursor/skills/**/SKILL.md` | `.cursor/agents/*.md` | hooks, notepads, MCP, policy |
|
|
62
|
-
| Gemini | `GEMINI.md`, `AGENTS.md` | — | `.gemini/skills/**/SKILL.md` | `.gemini/agents/*.md` | commands, extensions, settings |
|
|
63
|
-
|
|
64
|
-
Auto-detects which agents are present. Scans project-level, user-level (`~/`), and managed (`/etc/`) paths.
|
|
65
|
-
|
|
66
|
-
## Commands
|
|
67
|
-
|
|
68
|
-
| Command | Description |
|
|
69
|
-
|---------|-------------|
|
|
70
|
-
| `check [PATH]` | Validate instruction files (97 rules) |
|
|
71
|
-
| `explain RULE_ID` | Show rule details and fix guidance |
|
|
72
|
-
| `heal` | Auto-fix common violations |
|
|
73
|
-
| `install [PATH]` | Install CLI to PATH + MCP server |
|
|
74
|
-
| `update` | Upgrade to latest version |
|
|
75
|
-
| `auth login` | Sign in with GitHub |
|
|
76
|
-
| `version` | Show version info |
|
|
77
|
-
|
|
78
|
-
## What It Checks
|
|
79
|
-
|
|
80
|
-
97 rules across five categories:
|
|
81
|
-
|
|
82
|
-
- **Structure** — File organization, size limits, modularity
|
|
83
|
-
- **Content** — Specificity, reinforcement, tech stack, domain terminology
|
|
84
|
-
- **Efficiency** — Token usage, elaboration, formatting
|
|
85
|
-
- **Maintenance** — Versioning, review processes
|
|
86
|
-
- **Governance** — Security policies, credential protection
|
|
87
|
-
|
|
88
|
-
## Free vs Pro
|
|
89
|
-
|
|
90
|
-
| Feature | Free | Pro |
|
|
91
|
-
|---------|------|-----|
|
|
92
|
-
| Mechanical + structural rules | 97 rules, full detail | 97 rules, full detail |
|
|
93
|
-
| Content-quality checks (embedding-based) | Full detail | Full detail |
|
|
94
|
-
| Client checks (ordering, orphan, format, bold, scope) | Full detail | Full detail |
|
|
95
|
-
| Per-atom diagnostics (specificity, modality, brevity) | Full detail | Full detail |
|
|
96
|
-
| Interaction diagnostics (conflicts, competition, coupling) | Count per file | Full detail (line, fix, effect) |
|
|
97
|
-
| Cross-file analysis (conflicts, repetition) | Coordinates only | Full |
|
|
98
|
-
| Compliance band + system score | — | Full |
|
|
99
|
-
|
|
100
|
-
## GitHub Actions
|
|
101
|
-
|
|
102
|
-
```yaml
|
|
103
|
-
name: Reporails
|
|
104
|
-
on:
|
|
105
|
-
pull_request:
|
|
106
|
-
paths: ['CLAUDE.md', '.claude/**', 'AGENTS.md', '.cursorrules']
|
|
107
|
-
jobs:
|
|
108
|
-
check:
|
|
109
|
-
runs-on: ubuntu-latest
|
|
110
|
-
steps:
|
|
111
|
-
- uses: actions/checkout@v4
|
|
112
|
-
- run: npx @reporails/cli check --format github --strict
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
## How It Works
|
|
116
|
-
|
|
117
|
-
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.
|
|
118
|
-
|
|
119
|
-
## License
|
|
120
|
-
|
|
121
|
-
[BUSL 1.1](https://github.com/reporails/cli/blob/main/LICENSE) — converts to Apache 2.0 three years after each release.
|