docguard-cli 0.33.0 → 0.33.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/PRIVACY.md +45 -0
- package/README.md +16 -0
- package/docs/faq.md +19 -0
- package/extensions/spec-kit-docguard/extension.yml +1 -1
- 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/package.json +4 -3
package/PRIVACY.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Privacy Policy — DocGuard
|
|
2
|
+
|
|
3
|
+
**Effective: 2026-07-16**
|
|
4
|
+
|
|
5
|
+
DocGuard is a local-first command-line tool. This policy is short because the
|
|
6
|
+
honest answer is short: **DocGuard collects nothing.**
|
|
7
|
+
|
|
8
|
+
## What DocGuard does with your data
|
|
9
|
+
|
|
10
|
+
- **All analysis runs locally.** Validators, scoring, reports, the MCP server —
|
|
11
|
+
everything reads files on your machine and writes output to your machine.
|
|
12
|
+
Nothing is uploaded, sampled, or "improved" with your code or docs.
|
|
13
|
+
- **No telemetry, no analytics, no crash reporting.** There is no phone-home
|
|
14
|
+
code path. The deterministic core makes no network calls at all.
|
|
15
|
+
- **No accounts.** DocGuard has no sign-up, no API keys of its own, and no
|
|
16
|
+
server-side component operated by us.
|
|
17
|
+
|
|
18
|
+
## The explicit, user-initiated exceptions
|
|
19
|
+
|
|
20
|
+
Three commands can *prepare* outbound actions — each is opt-in, visible, and
|
|
21
|
+
executed by you or your own tooling, never silently by DocGuard:
|
|
22
|
+
|
|
23
|
+
| Command | What happens |
|
|
24
|
+
|---------|--------------|
|
|
25
|
+
| `docguard feedback` | Builds a **prefilled GitHub issue URL** (redacted and length-capped) and saves a local record. Nothing is sent unless you open the URL and submit it yourself. |
|
|
26
|
+
| `docguard upgrade --pr` / `impact --prs` | Shell out to **your** locally-authenticated `gh` CLI to interact with **your** repositories. DocGuard never holds credentials. |
|
|
27
|
+
| `docguard mcp --transport http` | Serves read-only tools over HTTP. Binds to loopback by default; binding a non-loopback address **refuses to start** without an `--api-key`. |
|
|
28
|
+
|
|
29
|
+
## Data written to disk (yours, locally)
|
|
30
|
+
|
|
31
|
+
State lives under `.docguard/` in your repo (fix history, score history,
|
|
32
|
+
caches) and `.docguard.baseline.json` if you create one. All of it is plain
|
|
33
|
+
text, in your repository, under your version control — delete it any time.
|
|
34
|
+
|
|
35
|
+
## Dependencies
|
|
36
|
+
|
|
37
|
+
One pinned runtime dependency (`@babel/parser`). The npm package is published
|
|
38
|
+
from GitHub Actions with provenance attestation, so you can verify the tarball
|
|
39
|
+
was built from this repository.
|
|
40
|
+
|
|
41
|
+
## Changes & contact
|
|
42
|
+
|
|
43
|
+
Changes to this policy land in this file with a dated entry in
|
|
44
|
+
[CHANGELOG.md](CHANGELOG.md). Questions: open an issue at
|
|
45
|
+
<https://github.com/raccioly/docguard/issues> (see [SUPPORT.md](SUPPORT.md)).
|
package/README.md
CHANGED
|
@@ -454,6 +454,15 @@ DocGuard ships **18 professional templates** with metadata, badges, and revision
|
|
|
454
454
|
|
|
455
455
|
## 🤖 AI Agent Support
|
|
456
456
|
|
|
457
|
+
### One-click MCP install
|
|
458
|
+
|
|
459
|
+
[](cursor://anysphere.cursor-deeplink/mcp/install?name=docguard&config=eyJjb21tYW5kIjogIm5weCIsICJhcmdzIjogWyIteSIsICJkb2NndWFyZC1jbGkiLCAibWNwIl19)
|
|
460
|
+
[](vscode:mcp/install?%7B%22name%22%3A%22docguard%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22docguard-cli%22%2C%22mcp%22%5D%7D)
|
|
461
|
+
|
|
462
|
+
- **Claude Code**: `claude mcp add docguard -- npx docguard-cli mcp`
|
|
463
|
+
- **Claude Desktop**: download `docguard-v<version>.mcpb` from the [latest release](https://github.com/raccioly/docguard/releases/latest) and drag it into Settings → Extensions — you'll be asked which project folder to analyze. No npm, no JSON editing.
|
|
464
|
+
- **Anything MCP**: DocGuard is a verified namespace on the [official MCP registry](https://registry.modelcontextprotocol.io/v0/servers?search=docguard) (`io.github.raccioly/docguard`).
|
|
465
|
+
|
|
457
466
|
DocGuard works with **every major AI coding agent**. All canonical docs are plain markdown — no vendor lock-in.
|
|
458
467
|
|
|
459
468
|
| Agent | Compatibility | Auto-Generate Config |
|
|
@@ -769,6 +778,13 @@ See [CONTRIBUTING.md](CONTRIBUTING.md#research--academic-credits) for full citat
|
|
|
769
778
|
|
|
770
779
|
---
|
|
771
780
|
|
|
781
|
+
## 🔒 Privacy & Supply Chain
|
|
782
|
+
|
|
783
|
+
DocGuard is local-first: no telemetry, no analytics, no phone-home — the full
|
|
784
|
+
(short) policy is in [PRIVACY.md](PRIVACY.md). npm releases are published with
|
|
785
|
+
[provenance attestation](https://docs.npmjs.com/generating-provenance-statements),
|
|
786
|
+
so you can verify each tarball was built by GitHub Actions from this repository.
|
|
787
|
+
|
|
772
788
|
## 📄 License
|
|
773
789
|
|
|
774
790
|
[MIT](LICENSE) — Free to use, modify, and distribute.
|
package/docs/faq.md
CHANGED
|
@@ -119,6 +119,25 @@ Exit code 0 = pass, 1 = fail. Use `--threshold` to set minimum score.
|
|
|
119
119
|
|
|
120
120
|
Yes — DocGuard ships a template at `templates/ci/github-actions.yml`. Copy it to `.github/workflows/` or use the reusable action in `action.yml`.
|
|
121
121
|
|
|
122
|
+
### Claude (or my AI agent) says DocGuard is "unknown" and wants a legitimacy check. Why?
|
|
123
|
+
|
|
124
|
+
That's the agent's default posture toward **any** third-party MCP server or
|
|
125
|
+
npx package — MCP servers run code with your permissions, so unknown ones get
|
|
126
|
+
a trust prompt. It's not a DocGuard-specific flag. What DocGuard provides so
|
|
127
|
+
the check can pass:
|
|
128
|
+
|
|
129
|
+
- **npm provenance** — releases are signed by GitHub Actions (Sigstore), so
|
|
130
|
+
the tarball is verifiably built from this repository.
|
|
131
|
+
- **Official MCP registry** — `io.github.raccioly/docguard` is a verified
|
|
132
|
+
namespace at registry.modelcontextprotocol.io.
|
|
133
|
+
- **Read-only annotations** — every MCP tool declares `readOnlyHint`; the
|
|
134
|
+
server never writes or reaches the network.
|
|
135
|
+
- **[PRIVACY.md](../PRIVACY.md)** — no telemetry, no data collection.
|
|
136
|
+
|
|
137
|
+
To stop the prompt on your own machines: approve with "Always allow", or
|
|
138
|
+
pre-trust it for a whole team via a project-scoped `.mcp.json` /
|
|
139
|
+
enterprise managed-settings allowlist.
|
|
140
|
+
|
|
122
141
|
### Does DocGuard block commits?
|
|
123
142
|
|
|
124
143
|
Only if you install hooks (`docguard hooks`). Without hooks, it's advisory only.
|
|
@@ -3,7 +3,7 @@ schema_version: "1.0"
|
|
|
3
3
|
extension:
|
|
4
4
|
id: "docguard"
|
|
5
5
|
name: "DocGuard — CDD Enforcement"
|
|
6
|
-
version: "0.33.
|
|
6
|
+
version: "0.33.1"
|
|
7
7
|
description: "Canonical-Driven Development enforcement as a true spec-kit extension. LLM-first design with automated validators, 4 AI behavior skills, spec-kit skill chaining, and workflow hooks. One pinned runtime dependency (@babel/parser); pure Node.js otherwise."
|
|
8
8
|
author: "Ricardo Accioly"
|
|
9
9
|
repository: "https://github.com/raccioly/docguard"
|
|
@@ -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.33.
|
|
9
|
+
version: 0.33.1
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-fix
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.33.
|
|
12
|
+
<!-- docguard:version: 0.33.1 -->
|
|
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.33.
|
|
10
|
+
version: 0.33.1
|
|
11
11
|
source: extensions/spec-kit-docguard/skills/docguard-guard
|
|
12
12
|
---
|
|
13
|
-
<!-- docguard:version: 0.33.
|
|
13
|
+
<!-- docguard:version: 0.33.1 -->
|
|
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.33.
|
|
9
|
+
version: 0.33.1
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-review
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.33.
|
|
12
|
+
<!-- docguard:version: 0.33.1 -->
|
|
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.33.
|
|
9
|
+
version: 0.33.1
|
|
10
10
|
source: extensions/spec-kit-docguard/skills/docguard-score
|
|
11
11
|
---
|
|
12
|
-
<!-- docguard:version: 0.33.
|
|
12
|
+
<!-- docguard:version: 0.33.1 -->
|
|
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.33.
|
|
7
|
+
version: 0.33.1
|
|
8
8
|
source: extensions/spec-kit-docguard/skills/docguard-sync
|
|
9
9
|
---
|
|
10
|
-
<!-- docguard:version: 0.33.
|
|
10
|
+
<!-- docguard:version: 0.33.1 -->
|
|
11
11
|
|
|
12
12
|
# DocGuard Sync Skill
|
|
13
13
|
|
package/package.json
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docguard-cli",
|
|
3
|
-
"version": "0.33.
|
|
3
|
+
"version": "0.33.1",
|
|
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": {
|
|
7
|
-
"docguard": "
|
|
7
|
+
"docguard": "cli/docguard.mjs"
|
|
8
8
|
},
|
|
9
9
|
"scripts": {
|
|
10
10
|
"docguard": "node cli/docguard.mjs",
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"license": "MIT",
|
|
37
37
|
"repository": {
|
|
38
38
|
"type": "git",
|
|
39
|
-
"url": "https://github.com/raccioly/docguard"
|
|
39
|
+
"url": "git+https://github.com/raccioly/docguard.git"
|
|
40
40
|
},
|
|
41
41
|
"homepage": "https://github.com/raccioly/docguard#readme",
|
|
42
42
|
"mcpName": "io.github.raccioly/docguard",
|
|
@@ -57,6 +57,7 @@
|
|
|
57
57
|
"docs/",
|
|
58
58
|
"schemas/",
|
|
59
59
|
"STANDARD.md",
|
|
60
|
+
"PRIVACY.md",
|
|
60
61
|
"PHILOSOPHY.md",
|
|
61
62
|
"README.md",
|
|
62
63
|
"LICENSE"
|