docguard-cli 0.5.1 → 0.6.0

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/docs/commands.md CHANGED
@@ -19,9 +19,9 @@ diagnose (identify + fix) → AI executes → guard (verify)
19
19
  **The AI orchestrator.** Runs all validators, maps every failure to an AI fix prompt, outputs a remediation plan.
20
20
 
21
21
  ```bash
22
- npx docguard diagnose # Human-readable remediation plan
23
- npx docguard diagnose --format json # Structured for automation
24
- npx docguard diagnose --format prompt # Raw AI prompt (all issues combined)
22
+ npx docguard-cli diagnose # Human-readable remediation plan
23
+ npx docguard-cli diagnose --format json # Structured for automation
24
+ npx docguard-cli diagnose --format prompt # Raw AI prompt (all issues combined)
25
25
  ```
26
26
 
27
27
  **JSON output includes:**
@@ -35,9 +35,9 @@ npx docguard diagnose --format prompt # Raw AI prompt (all issues combined)
35
35
  **Identify issues.** Validate project against canonical docs. Use for CI gates and pre-commit hooks.
36
36
 
37
37
  ```bash
38
- npx docguard guard # Text output
39
- npx docguard guard --format json # Structured JSON
40
- npx docguard guard --verbose # Show all check details
38
+ npx docguard-cli guard # Text output
39
+ npx docguard-cli guard --format json # Structured JSON
40
+ npx docguard-cli guard --verbose # Show all check details
41
41
  ```
42
42
 
43
43
  **Exit codes:** `0` (pass), `1` (errors), `2` (warnings)
@@ -63,9 +63,9 @@ When issues are found, guard outputs: `Run docguard diagnose to get AI fix promp
63
63
  **CDD maturity score** (0-100) with category breakdown.
64
64
 
65
65
  ```bash
66
- npx docguard score # Visual bar chart
67
- npx docguard score --format json # Structured JSON
68
- npx docguard score --tax # Documentation tax estimate
66
+ npx docguard-cli score # Visual bar chart
67
+ npx docguard-cli score --format json # Structured JSON
68
+ npx docguard-cli score --tax # Documentation tax estimate
69
69
  ```
70
70
 
71
71
  **`--tax` output:**
@@ -89,11 +89,11 @@ Tax-to-value ratio: LOW
89
89
  **Initialize CDD documentation** from templates.
90
90
 
91
91
  ```bash
92
- npx docguard init # Full CDD (standard profile)
93
- npx docguard init --profile starter # Minimal: ARCHITECTURE + CHANGELOG
94
- npx docguard init --profile enterprise # Everything + strict validators
95
- npx docguard init --dir /path/to/project # Specify directory
96
- npx docguard init --skip-prompts # No AI prompt output
92
+ npx docguard-cli init # Full CDD (standard profile)
93
+ npx docguard-cli init --profile starter # Minimal: ARCHITECTURE + CHANGELOG
94
+ npx docguard-cli init --profile enterprise # Everything + strict validators
95
+ npx docguard-cli init --dir /path/to/project # Specify directory
96
+ npx docguard-cli init --skip-prompts # No AI prompt output
97
97
  ```
98
98
 
99
99
  **Profiles:**
@@ -109,8 +109,8 @@ npx docguard init --skip-prompts # No AI prompt output
109
109
  **Reverse-engineer docs from existing code.** Scans your codebase and creates pre-filled documentation.
110
110
 
111
111
  ```bash
112
- npx docguard generate
113
- npx docguard generate --dir /path/to/project
112
+ npx docguard-cli generate
113
+ npx docguard-cli generate --dir /path/to/project
114
114
  ```
115
115
 
116
116
  **Detects:** Next.js, React, Vue, Angular, Express, Fastify, Hono, Django, FastAPI, SvelteKit, and more.
@@ -120,7 +120,7 @@ npx docguard generate --dir /path/to/project
120
120
  **Scan and report** which CDD documents exist, are missing, or need attention.
121
121
 
122
122
  ```bash
123
- npx docguard audit
123
+ npx docguard-cli audit
124
124
  ```
125
125
 
126
126
  ---
@@ -132,10 +132,10 @@ npx docguard audit
132
132
  **Find issues and generate AI fix instructions.**
133
133
 
134
134
  ```bash
135
- npx docguard fix # Human-readable issue list
136
- npx docguard fix --format json # Machine-readable for VS Code/CI
137
- npx docguard fix --format prompt # AI-ready prompt
138
- npx docguard fix --auto # Create missing skeleton files
135
+ npx docguard-cli fix # Human-readable issue list
136
+ npx docguard-cli fix --format json # Machine-readable for VS Code/CI
137
+ npx docguard-cli fix --format prompt # AI-ready prompt
138
+ npx docguard-cli fix --auto # Create missing skeleton files
139
139
  ```
140
140
 
141
141
  ### `docguard fix --doc <name>`
@@ -143,11 +143,11 @@ npx docguard fix --auto # Create missing skeleton files
143
143
  **Generate a deep AI research prompt** for a specific document.
144
144
 
145
145
  ```bash
146
- npx docguard fix --doc architecture
147
- npx docguard fix --doc data-model
148
- npx docguard fix --doc security
149
- npx docguard fix --doc test-spec
150
- npx docguard fix --doc environment
146
+ npx docguard-cli fix --doc architecture
147
+ npx docguard-cli fix --doc data-model
148
+ npx docguard-cli fix --doc security
149
+ npx docguard-cli fix --doc test-spec
150
+ npx docguard-cli fix --doc environment
151
151
  ```
152
152
 
153
153
  **Output includes:** TASK, PURPOSE, RESEARCH STEPS (what to grep/read), WRITE THE DOCUMENT (expected sections).
@@ -157,8 +157,8 @@ npx docguard fix --doc environment
157
157
  **Generate agent-specific config files** from AGENTS.md.
158
158
 
159
159
  ```bash
160
- npx docguard agents
161
- npx docguard agents --list
160
+ npx docguard-cli agents
161
+ npx docguard-cli agents --list
162
162
  ```
163
163
 
164
164
  ---
@@ -170,10 +170,10 @@ npx docguard agents --list
170
170
  **Single command for CI/CD pipelines.** Runs guard + score internally (no subprocess).
171
171
 
172
172
  ```bash
173
- npx docguard ci # Basic check
174
- npx docguard ci --threshold 70 # Fail below score 70
175
- npx docguard ci --threshold 80 --fail-on-warning # Strict mode
176
- npx docguard ci --format json # JSON for GitHub Actions
173
+ npx docguard-cli ci # Basic check
174
+ npx docguard-cli ci --threshold 70 # Fail below score 70
175
+ npx docguard-cli ci --threshold 80 --fail-on-warning # Strict mode
176
+ npx docguard-cli ci --format json # JSON for GitHub Actions
177
177
  ```
178
178
 
179
179
  ### `docguard hooks`
@@ -181,9 +181,9 @@ npx docguard ci --format json # JSON for GitHub Actions
181
181
  **Install git hooks** for automatic validation.
182
182
 
183
183
  ```bash
184
- npx docguard hooks # Install all hooks
185
- npx docguard hooks --list # Show installed hooks
186
- npx docguard hooks --remove # Remove hooks
184
+ npx docguard-cli hooks # Install all hooks
185
+ npx docguard-cli hooks --list # Show installed hooks
186
+ npx docguard-cli hooks --remove # Remove hooks
187
187
  ```
188
188
 
189
189
  **Hooks installed:**
@@ -196,8 +196,8 @@ npx docguard hooks --remove # Remove hooks
196
196
  **Live watch mode** — re-runs guard on file changes.
197
197
 
198
198
  ```bash
199
- npx docguard watch # Watch and re-run guard
200
- npx docguard watch --auto-fix # Also output AI fix prompts on failure
199
+ npx docguard-cli watch # Watch and re-run guard
200
+ npx docguard-cli watch --auto-fix # Also output AI fix prompts on failure
201
201
  ```
202
202
 
203
203
  ### `docguard badge`
@@ -205,8 +205,8 @@ npx docguard watch --auto-fix # Also output AI fix prompts on failure
205
205
  **Generate shields.io badges** for README.
206
206
 
207
207
  ```bash
208
- npx docguard badge
209
- npx docguard badge --format json
208
+ npx docguard-cli badge
209
+ npx docguard-cli badge --format json
210
210
  ```
211
211
 
212
212
  ### `docguard diff`
@@ -214,7 +214,7 @@ npx docguard badge --format json
214
214
  **Show gaps** between documentation and actual codebase.
215
215
 
216
216
  ```bash
217
- npx docguard diff
217
+ npx docguard-cli diff
218
218
  ```
219
219
 
220
220
  ---
package/docs/faq.md CHANGED
@@ -110,7 +110,7 @@ If tax is HIGH, consider using `starter` profile or letting AI handle more.
110
110
  ### How do I add DocGuard to CI?
111
111
 
112
112
  ```bash
113
- npx docguard ci --format json --threshold 70
113
+ npx docguard-cli ci --format json --threshold 70
114
114
  ```
115
115
 
116
116
  Exit code 0 = pass, 1 = fail. Use `--threshold` to set minimum score.
package/docs/profiles.md CHANGED
@@ -11,7 +11,7 @@ Requiring all 5 canonical docs for a weekend side project is overkill. Requiring
11
11
  ### `starter` — For side projects and prototypes
12
12
 
13
13
  ```bash
14
- npx docguard init --profile starter
14
+ npx docguard-cli init --profile starter
15
15
  ```
16
16
 
17
17
  **Creates:** ARCHITECTURE.md, CHANGELOG.md, AGENTS.md, DRIFT-LOG.md
@@ -25,8 +25,8 @@ npx docguard init --profile starter
25
25
  ### `standard` — For team projects (default)
26
26
 
27
27
  ```bash
28
- npx docguard init # default profile
29
- npx docguard init --profile standard # explicit
28
+ npx docguard-cli init # default profile
29
+ npx docguard-cli init --profile standard # explicit
30
30
  ```
31
31
 
32
32
  **Creates:** All 5 canonical docs + AGENTS.md + CHANGELOG.md + DRIFT-LOG.md
@@ -40,7 +40,7 @@ npx docguard init --profile standard # explicit
40
40
  ### `enterprise` — For regulated and critical projects
41
41
 
42
42
  ```bash
43
- npx docguard init --profile enterprise
43
+ npx docguard-cli init --profile enterprise
44
44
  ```
45
45
 
46
46
  **Creates:** All 5 canonical docs + all tracking files
@@ -54,7 +54,7 @@ npx docguard init --profile enterprise
54
54
  ### At init time
55
55
 
56
56
  ```bash
57
- npx docguard init --profile starter
57
+ npx docguard-cli init --profile starter
58
58
  ```
59
59
 
60
60
  ### In `.docguard.json`
@@ -97,7 +97,7 @@ Change the `"profile"` field in `.docguard.json` and run `docguard diagnose` to
97
97
  ## Measuring the Cost
98
98
 
99
99
  ```bash
100
- npx docguard score --tax
100
+ npx docguard-cli score --tax
101
101
  ```
102
102
 
103
103
  Shows estimated weekly maintenance time. If the tax is HIGH, consider downgrading your profile. If LOW, you might benefit from upgrading.
@@ -8,7 +8,7 @@ Get AI-enforced documentation in under 5 minutes.
8
8
 
9
9
  ```bash
10
10
  cd your-project
11
- npx docguard init --profile starter
11
+ npx docguard-cli init --profile starter
12
12
  ```
13
13
 
14
14
  Creates only ARCHITECTURE.md + CHANGELOG — the bare minimum.
@@ -17,7 +17,7 @@ Creates only ARCHITECTURE.md + CHANGELOG — the bare minimum.
17
17
 
18
18
  ```bash
19
19
  cd your-project
20
- npx docguard init
20
+ npx docguard-cli init
21
21
  ```
22
22
 
23
23
  Creates all 5 canonical docs + tracking files + AI slash commands.
@@ -26,7 +26,7 @@ Creates all 5 canonical docs + tracking files + AI slash commands.
26
26
 
27
27
  ```bash
28
28
  cd your-project
29
- npx docguard generate
29
+ npx docguard-cli generate
30
30
  ```
31
31
 
32
32
  Scans your codebase and generates pre-filled documentation.
@@ -36,7 +36,7 @@ Scans your codebase and generates pre-filled documentation.
36
36
  After init creates skeleton templates, run **one command**:
37
37
 
38
38
  ```bash
39
- npx docguard diagnose
39
+ npx docguard-cli diagnose
40
40
  ```
41
41
 
42
42
  This outputs a complete AI remediation plan. If you're using Claude Code, Cursor, Copilot, or Antigravity, the AI reads the output and writes every doc automatically.
@@ -52,22 +52,22 @@ diagnose → AI reads prompts → AI fixes docs → guard verifies
52
52
  ## Verify
53
53
 
54
54
  ```bash
55
- npx docguard guard # Pass/fail check
56
- npx docguard score # 0-100 maturity score
57
- npx docguard score --tax # How much time docs cost you
55
+ npx docguard-cli guard # Pass/fail check
56
+ npx docguard-cli score # 0-100 maturity score
57
+ npx docguard-cli score --tax # How much time docs cost you
58
58
  ```
59
59
 
60
60
  ## Automate
61
61
 
62
62
  ```bash
63
63
  # Git hooks (auto-check on commit/push)
64
- npx docguard hooks
64
+ npx docguard-cli hooks
65
65
 
66
66
  # CI/CD pipelines
67
- npx docguard ci --threshold 70
67
+ npx docguard-cli ci --threshold 70
68
68
 
69
69
  # Live watch mode with auto-fix
70
- npx docguard watch --auto-fix
70
+ npx docguard-cli watch --auto-fix
71
71
  ```
72
72
 
73
73
  ## What's Next?
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docguard-cli",
3
- "version": "0.5.1",
3
+ "version": "0.6.0",
4
4
  "description": "The enforcement tool for Canonical-Driven Development (CDD). Audit, generate, and guard your project documentation.",
5
5
  "type": "module",
6
6
  "bin": {
@@ -21,7 +21,7 @@ jobs:
21
21
  node-version: '20'
22
22
 
23
23
  - name: Run DocGuard CI
24
- run: npx docguard ci --format json --threshold 70 > docguard-report.json
24
+ run: npx docguard-cli ci --format json --threshold 70 > docguard-report.json
25
25
 
26
26
  - name: Display Results
27
27
  if: always()