@reporails/cli 0.5.5 → 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.
Files changed (2) hide show
  1. package/README.md +63 -83
  2. package/package.json +4 -1
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
- # @reporails/cli
1
+ # Reporails CLI (v0.5.7)
2
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.
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
6
 
7
7
  ## Quick Start
8
8
 
@@ -12,110 +12,90 @@ npx @reporails/cli check
12
12
  uvx --from reporails-cli ails check
13
13
  ```
14
14
 
15
- No install, no account. Actionable findings in seconds:
15
+ No install, no account. Actionable findings in seconds - fix them, run again, watch the score improve:
16
16
 
17
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
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
26
  │
27
- └─ 21 findings
27
+ └─ 181 findings
28
28
 
29
- Score: 7.9 / 10 ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░ (1.3s)
30
- 21 findings · 4 warnings · 1 info
31
- Compliance: HIGH
32
- ```
29
+ [⋯ Agents (3) · Skills (10) · Rules (13) +318 findings ⋯]
33
30
 
34
- ## Install
31
+ ── Summary ────────────────────────────────────────────────────────
35
32
 
36
- ```bash
37
- # One-shot (no install needed)
38
- npx @reporails/cli check
33
+ Score: 7.3 / 10 ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░ (3.9s)
34
+ Agent: Claude
39
35
 
40
- # Permanent install (puts ails on PATH + configures MCP)
41
- npx @reporails/cli install
42
- # or
43
- uvx --from reporails-cli ails install
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
44
45
  ```
45
46
 
46
- Once installed, use `ails` directly:
47
+ ## Install permanently
47
48
 
48
49
  ```bash
49
- ails check # Validate instruction files
50
- ails update # Upgrade to latest version
51
- ails auth login # Unlock full diagnostics (GitHub sign-in)
50
+ npx @reporails/cli install
51
+ # or
52
+ uvx --from reporails-cli ails install
52
53
  ```
53
54
 
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 |
55
+ Puts `ails` on your PATH.
63
56
 
64
- Auto-detects which agents are present. Scans project-level, user-level (`~/`), and managed (`/etc/`) paths.
57
+ ## Anonymous vs signed
65
58
 
66
- ## Commands
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.
67
60
 
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 |
61
+ ```bash
62
+ # GitHub Device Flow - authorize in browser
63
+ ails auth login
64
+ ```
77
65
 
78
- ## What It Checks
66
+ Full breakdown: [Tiers and Limits](https://github.com/reporails/cli/blob/main/docs/tiers.md).
79
67
 
80
- 97 rules across five categories:
68
+ ## In CI
81
69
 
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
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.
87
71
 
88
- ## Free vs Pro
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
+ ```
89
79
 
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 |
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).
99
81
 
100
- ## GitHub Actions
82
+ ## Documentation
101
83
 
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
- ```
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
114
90
 
115
- ## How It Works
91
+ ## Built and validated for
116
92
 
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.
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)
118
98
 
119
99
  ## License
120
100
 
121
- [BUSL 1.1](https://github.com/reporails/cli/blob/main/LICENSE) — converts to Apache 2.0 three years after each release.
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.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",