@reporails/cli 0.1.4 → 0.2.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 CHANGED
@@ -23,7 +23,7 @@ npx @reporails/cli check
23
23
  That's it. You'll get a score, capability level, and actionable violations.
24
24
  ```
25
25
  ╔══════════════════════════════════════════════════════════════╗
26
- ║ SCORE: 8.1 / 10 (partial) | CAPABILITY: Governed (L5) ║
26
+ ║ SCORE: 8.1 / 10 (partial) | CAPABILITY: Maintained (L5) ║
27
27
  ║ ▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓░░░░░░░░░░░ ║
28
28
  ╚══════════════════════════════════════════════════════════════╝
29
29
 
@@ -58,14 +58,17 @@ Once installed, all commands use `ails` directly.
58
58
 
59
59
  ## Capability Levels
60
60
 
61
- | Level | Name | What it means |
62
- |-------|------|---------------|
63
- | L1 | Absent | No instruction file |
64
- | L2 | Basic | Has CLAUDE.md |
65
- | L3 | Structured | Sections, imports |
66
- | L4 | Abstracted | .claude/rules/ directory |
67
- | L5 | Governed | Shared files, 3+ components |
68
- | L6 | Adaptive | Backbone + full governance |
61
+ Capability levels describe what your AI instruction setup enables — not how "mature" it is. Different projects need different capabilities.
62
+
63
+ | Level | Name | What It Enables |
64
+ |-------|------|-----------------|
65
+ | L0 | Absent | No instruction file — nothing to evaluate |
66
+ | L1 | Basic | Reviewed, tracked instruction file |
67
+ | L2 | Scoped | Project-specific constraints, size control |
68
+ | L3 | Structured | External references, multiple files |
69
+ | L4 | Abstracted | Path-scoped rules, context-aware loading |
70
+ | L5 | Maintained | Structural integrity, governance, navigation |
71
+ | L6 | Adaptive | Dynamic context, extensibility, persistence |
69
72
 
70
73
  ## Commands
71
74
 
@@ -73,13 +76,17 @@ Once installed, all commands use `ails` directly.
73
76
  ails check # Score your setup
74
77
  ails check -f json # JSON output (for CI)
75
78
  ails check --strict # Exit 1 if violations (for CI)
76
- ails check --with-recommended # Include recommended rules
77
- ails explain S1 # Explain a rule
79
+ ails check --no-update-check # Skip pre-run update prompt
80
+ ails check --exclude-dir vendor # Exclude directory from scanning
81
+ ails explain CORE:S:0001 # Explain a rule
78
82
  ails map # Show project structure
79
83
  ails map --save # Generate backbone.yml
80
- ails update # Update rules framework
81
- ails update --check # Check for rule updates
82
- ails dismiss C6 # Dismiss a semantic finding
84
+ ails update # Update rules framework + recommended
85
+ ails update --check # Check for updates without installing
86
+ ails update --recommended # Update recommended rules only
87
+ ails update --force # Force reinstall even if current
88
+ ails update --cli # Upgrade the CLI package itself
89
+ ails dismiss CORE:C:0001 # Dismiss a semantic finding
83
90
  ails version # Show version info
84
91
  ```
85
92
 
@@ -90,29 +97,37 @@ ails version # Show version info
90
97
  | `check [PATH]` | Validate instruction files |
91
98
  | `explain RULE_ID` | Show rule details |
92
99
  | `map [PATH]` | Discover project structure |
93
- | `update` | Update rules framework |
100
+ | `update` | Update rules framework + recommended |
94
101
  | `dismiss RULE_ID` | Dismiss a semantic finding |
95
102
  | `version` | Show version info |
96
103
 
97
104
  ## Updating
98
105
 
99
- The **rules framework** updates separately from the CLI:
100
-
101
106
  ```bash
102
- ails update # Update rules to latest
103
- ails update --check # Check without installing
107
+ ails update # Update rules framework + recommended to latest
108
+ ails update --check # Check for updates without installing
109
+ ails update --recommended # Update recommended rules only
110
+ ails update --force # Force reinstall even if current
111
+ ails update --cli # Upgrade the CLI package itself
104
112
  ```
105
113
 
114
+ Before each scan, the CLI prompts when updates are available. Use `--no-update-check` to skip.
115
+
106
116
  The **CLI itself** updates automatically — `npx @reporails/cli` always fetches the latest version.
107
117
  Persistent installs: `npm install -g @reporails/cli@latest`
108
118
 
109
119
  ## Recommended Rules
110
120
 
111
- The `--with-recommended` flag adds community [recommended rules](https://github.com/reporails/recommended) on top of the core set. These are methodology-backed checks (AILS_ namespace) that are auto-downloaded on first use:
121
+ [Recommended rules](https://github.com/reporails/recommended) (AILS_ namespace) are included by default and auto-downloaded on first run. To opt out, add to your `.reporails/config.yml`:
122
+
123
+ ```yaml
124
+ recommended: false
125
+ ```
126
+
127
+ To update recommended rules independently:
112
128
 
113
129
  ```bash
114
- ails check --with-recommended # Include recommended rules
115
- ails update --recommended # Re-fetch latest recommended rules
130
+ ails update --recommended
116
131
  ```
117
132
 
118
133
  ## Prerequisites
@@ -134,4 +149,4 @@ Want to add or improve rules? Please follow [Contribute](https://github.com/repo
134
149
 
135
150
  ## License
136
151
 
137
- Apache-2.0
152
+ BUSL 1.1
package/bin/reporails.mjs CHANGED
@@ -16,7 +16,11 @@ Usage:
16
16
  reporails uninstall [--scope user|project] Remove MCP server from Claude Code
17
17
  reporails check [PATH] [OPTIONS] Validate instruction files
18
18
  reporails explain RULE_ID Show rule details
19
- reporails update Update rules framework
19
+ reporails map [PATH] [--save] Discover project structure
20
+ reporails update Update rules framework + recommended
21
+ reporails update --check Check for updates without installing
22
+ reporails update --recommended Update recommended rules only
23
+ reporails update --cli Upgrade CLI package itself
20
24
  reporails dismiss RULE_ID Dismiss a semantic finding
21
25
  reporails version Show version info
22
26
  reporails <command> [args...] Proxy any command to ails CLI
@@ -24,8 +28,8 @@ Usage:
24
28
  Examples:
25
29
  npx @reporails/cli install # Add MCP server (user scope)
26
30
  npx @reporails/cli check # Score your setup
27
- npx @reporails/cli explain S1 # Explain a rule
28
- npx @reporails/cli update # Update rules
31
+ npx @reporails/cli explain CORE:S:0001 # Explain a rule
32
+ npx @reporails/cli update # Update rules + recommended
29
33
 
30
34
  Prerequisites:
31
35
  Node.js >= 18 (uv is auto-installed if missing)
@@ -97,7 +101,7 @@ function install(args) {
97
101
  ensureUv();
98
102
 
99
103
  const scope = parseScope(args);
100
- const cmd = `claude mcp add --scope ${scope} reporails -- uvx --from ${PYPI_PACKAGE} ${MCP_COMMAND}`;
104
+ const cmd = `claude mcp add --scope ${scope} reporails -- uvx --refresh --from ${PYPI_PACKAGE} ${MCP_COMMAND}`;
101
105
  console.log(`Registering MCP server (scope: ${scope})...`);
102
106
 
103
107
  try {
@@ -133,7 +137,7 @@ function uninstall(args) {
133
137
  function proxy(args) {
134
138
  ensureUv();
135
139
 
136
- const child = spawn("uvx", ["--from", PYPI_PACKAGE, CLI_COMMAND, ...args], {
140
+ const child = spawn("uvx", ["--refresh", "--from", PYPI_PACKAGE, CLI_COMMAND, ...args], {
137
141
  stdio: "inherit",
138
142
  });
139
143
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@reporails/cli",
3
- "version": "0.1.4",
3
+ "version": "0.2.1",
4
4
  "description": "Score your CLAUDE.md files. See what's missing. Improve your AI coding setup.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -25,6 +25,6 @@
25
25
  "type": "git",
26
26
  "url": "https://github.com/reporails/cli"
27
27
  },
28
- "license": "Apache-2.0",
28
+ "license": "BUSL-1.1",
29
29
  "author": "Reporails"
30
30
  }