docguard-cli 0.40.4 → 0.40.5
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/extensions/spec-kit-docguard/README.md +3 -0
- package/extensions/spec-kit-docguard/commands/review.md +50 -0
- package/extensions/spec-kit-docguard/extension.yml +16 -4
- package/extensions/spec-kit-docguard/skills/docguard-fix/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/skills/docguard-guard/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/skills/docguard-review/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/skills/docguard-score/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/skills/docguard-sync/SKILL.md +2 -2
- package/extensions/spec-kit-docguard/templates/github-workflows/docguard-autofix.yml +1 -1
- package/extensions/spec-kit-docguard/templates/github-workflows/docguard-guard.yml +1 -1
- package/package.json +1 -1
- package/templates/ci/github-actions.yml +1 -1
|
@@ -45,12 +45,15 @@ docguard score
|
|
|
45
45
|
|
|
46
46
|
| Command | Alias | Purpose |
|
|
47
47
|
|---------|-------|---------|
|
|
48
|
+
| `speckit.docguard.init` | `docguard.init` | Initialize CDD in a project |
|
|
48
49
|
| `speckit.docguard.guard` | `docguard.guard` | Run configurable quality gate with severity triage |
|
|
49
50
|
| `speckit.docguard.fix` | `docguard.fix` | AI-driven documentation repair with codebase research |
|
|
50
51
|
| `speckit.docguard.review` | `docguard.review` | Cross-document semantic consistency analysis (read-only) |
|
|
51
52
|
| `speckit.docguard.score` | `docguard.score` | CDD maturity score with ROI improvement roadmap |
|
|
52
53
|
| `speckit.docguard.diagnose` | — | Diagnose issues + generate multi-perspective AI prompts |
|
|
53
54
|
| `speckit.docguard.generate` | — | Reverse-engineer canonical docs from codebase |
|
|
55
|
+
| `speckit.docguard.sync` | — | Refresh code-truth sections and flag prose for review |
|
|
56
|
+
| `speckit.docguard.trace` | — | Generate requirements traceability matrix |
|
|
54
57
|
| `speckit.docguard.brief` | — | Load current spec intent before specification |
|
|
55
58
|
| `speckit.docguard.preflight` | — | Gate the generated spec before task generation |
|
|
56
59
|
| `speckit.docguard.complete` | — | Plan reviewed completion and regenerate active context after verification |
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Review documentation against code without modifying the repository"
|
|
3
|
+
allowed-tools: Bash, Read
|
|
4
|
+
handoffs:
|
|
5
|
+
- label: Fix Reviewed Issues
|
|
6
|
+
agent: docguard.fix
|
|
7
|
+
prompt: Fix the documentation issues confirmed by the review
|
|
8
|
+
- label: Run Guard
|
|
9
|
+
agent: docguard.guard
|
|
10
|
+
prompt: Validate all checks after approved fixes
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
# DocGuard Review
|
|
14
|
+
|
|
15
|
+
Perform a read-only semantic review of canonical documentation against the
|
|
16
|
+
repository. Report evidence and recommendations; do not edit files.
|
|
17
|
+
|
|
18
|
+
## User Input
|
|
19
|
+
|
|
20
|
+
```text
|
|
21
|
+
$ARGUMENTS
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
You **MUST** consider the user input before proceeding when it is not empty.
|
|
25
|
+
|
|
26
|
+
## Execution
|
|
27
|
+
|
|
28
|
+
1. Run the deterministic inventory and quality checks:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npx --yes docguard-cli@latest diagnose $ARGUMENTS
|
|
32
|
+
npx --yes docguard-cli@latest diff $ARGUMENTS
|
|
33
|
+
npx --yes docguard-cli@latest score $ARGUMENTS
|
|
34
|
+
npx --yes docguard-cli@latest verify --evidence --format json $ARGUMENTS
|
|
35
|
+
npx --yes docguard-cli@latest verify --semantic $ARGUMENTS
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
2. Read the canonical documents and their cited code. Check architecture,
|
|
39
|
+
schemas, security claims, test coverage, terminology, and cross-references.
|
|
40
|
+
3. For every contradiction, identify whether approved documentation or current
|
|
41
|
+
code owns the intended behavior. A mismatch can be a code regression.
|
|
42
|
+
4. Return a severity-ranked report with exact file paths, evidence, confidence,
|
|
43
|
+
and a proposed next action. Keep unsupported claims explicitly unverified.
|
|
44
|
+
|
|
45
|
+
## Constraints
|
|
46
|
+
|
|
47
|
+
- Do not modify files or treat a clean structural guard as proof that prose is
|
|
48
|
+
factually correct.
|
|
49
|
+
- Do not rewrite canonical intent to match code until ownership is resolved.
|
|
50
|
+
- Cap the report at 50 findings and aggregate lower-priority overflow.
|
|
@@ -3,8 +3,8 @@ schema_version: "1.0"
|
|
|
3
3
|
extension:
|
|
4
4
|
id: "docguard"
|
|
5
5
|
name: "DocGuard — CDD Enforcement"
|
|
6
|
-
version: "0.40.
|
|
7
|
-
description: "
|
|
6
|
+
version: "0.40.5"
|
|
7
|
+
description: "Documentation integrity for AI-assisted repositories: lifecycle registry, drift validation, traceability, safe archival, SARIF/JUnit, MCP, GitHub Actions, and Spec Kit hooks."
|
|
8
8
|
author: "Ricardo Accioly"
|
|
9
9
|
repository: "https://github.com/raccioly/docguard"
|
|
10
10
|
license: "MIT"
|
|
@@ -25,16 +25,20 @@ requires:
|
|
|
25
25
|
|
|
26
26
|
provides:
|
|
27
27
|
commands:
|
|
28
|
+
- name: "speckit.docguard.init"
|
|
29
|
+
file: "commands/init.md"
|
|
30
|
+
description: "Initialize Canonical-Driven Development in a project"
|
|
31
|
+
|
|
28
32
|
- name: "speckit.docguard.guard"
|
|
29
33
|
file: "commands/guard.md"
|
|
30
34
|
description: "Run configurable quality gate with severity triage and remediation plan"
|
|
31
35
|
|
|
32
36
|
- name: "speckit.docguard.fix"
|
|
33
|
-
file: "commands/
|
|
37
|
+
file: "commands/fix.md"
|
|
34
38
|
description: "AI-driven documentation repair with codebase research and validation loops"
|
|
35
39
|
|
|
36
40
|
- name: "speckit.docguard.review"
|
|
37
|
-
file: "commands/
|
|
41
|
+
file: "commands/review.md"
|
|
38
42
|
description: "Cross-document semantic consistency analysis (read-only)"
|
|
39
43
|
|
|
40
44
|
- name: "speckit.docguard.score"
|
|
@@ -49,6 +53,14 @@ provides:
|
|
|
49
53
|
file: "commands/generate.md"
|
|
50
54
|
description: "Reverse-engineer canonical docs from existing codebase"
|
|
51
55
|
|
|
56
|
+
- name: "speckit.docguard.sync"
|
|
57
|
+
file: "commands/sync.md"
|
|
58
|
+
description: "Refresh generated code-truth sections while preserving human prose"
|
|
59
|
+
|
|
60
|
+
- name: "speckit.docguard.trace"
|
|
61
|
+
file: "commands/trace.md"
|
|
62
|
+
description: "Generate the requirements traceability matrix"
|
|
63
|
+
|
|
52
64
|
- name: "speckit.docguard.brief"
|
|
53
65
|
file: "commands/brief.md"
|
|
54
66
|
description: "Brief prior spec intent and lifecycle before creating a new specification"
|
|
@@ -6,10 +6,10 @@ description: AI-driven documentation repair with structured research workflow, t
|
|
|
6
6
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
7
7
|
metadata:
|
|
8
8
|
author: docguard
|
|
9
|
-
version: 0.40.
|
|
9
|
+
version: 0.40.5
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-fix
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.40.
|
|
12
|
+
<!-- docguard:version: 0.40.5 -->
|
|
13
13
|
|
|
14
14
|
# DocGuard Fix Skill
|
|
15
15
|
|
|
@@ -7,10 +7,10 @@ description: Run DocGuard guard validation against Canonical-Driven Development
|
|
|
7
7
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
8
8
|
metadata:
|
|
9
9
|
author: docguard
|
|
10
|
-
version: 0.40.
|
|
10
|
+
version: 0.40.5
|
|
11
11
|
source: extensions/spec-kit-docguard/skills/docguard-guard
|
|
12
12
|
---
|
|
13
|
-
<!-- docguard:version: 0.40.
|
|
13
|
+
<!-- docguard:version: 0.40.5 -->
|
|
14
14
|
|
|
15
15
|
# DocGuard Guard Skill
|
|
16
16
|
|
|
@@ -6,10 +6,10 @@ description: Cross-document consistency analysis and quality assessment. Perform
|
|
|
6
6
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
7
7
|
metadata:
|
|
8
8
|
author: docguard
|
|
9
|
-
version: 0.40.
|
|
9
|
+
version: 0.40.5
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-review
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.40.
|
|
12
|
+
<!-- docguard:version: 0.40.5 -->
|
|
13
13
|
|
|
14
14
|
# DocGuard Review Skill
|
|
15
15
|
|
|
@@ -6,10 +6,10 @@ description: CDD maturity assessment with category-aware improvement roadmap. Ru
|
|
|
6
6
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
7
7
|
metadata:
|
|
8
8
|
author: docguard
|
|
9
|
-
version: 0.40.
|
|
9
|
+
version: 0.40.5
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-score
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.40.
|
|
12
|
+
<!-- docguard:version: 0.40.5 -->
|
|
13
13
|
|
|
14
14
|
# DocGuard Score Skill
|
|
15
15
|
|
|
@@ -4,10 +4,10 @@ description: Keep canonical documentation ALWAYS UP TO DATE. Refreshes code-trut
|
|
|
4
4
|
compatibility: Requires DocGuard CLI installed (npm i -g docguard-cli or npx docguard-cli)
|
|
5
5
|
metadata:
|
|
6
6
|
author: docguard
|
|
7
|
-
version: 0.40.
|
|
7
|
+
version: 0.40.5
|
|
8
8
|
source: extensions/spec-kit-docguard/skills/docguard-sync
|
|
9
9
|
---
|
|
10
|
-
<!-- docguard:version: 0.40.
|
|
10
|
+
<!-- docguard:version: 0.40.5 -->
|
|
11
11
|
|
|
12
12
|
# DocGuard Sync Skill
|
|
13
13
|
|
package/package.json
CHANGED