docguard-cli 0.5.1 → 0.5.2

package/README.md

@@ -3,9 +3,11 @@
 > **AI-native documentation enforcement for Canonical-Driven Development (CDD).**  
 > AI diagnoses. AI fixes. AI verifies. Humans review.
 
+[![npm](https://img.shields.io/npm/v/docguard-cli)](https://www.npmjs.com/package/docguard-cli)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node.js](https://img.shields.io/badge/Node.js-18%2B-green)](https://nodejs.org)
 [![Zero Dependencies](https://img.shields.io/badge/Dependencies-0-brightgreen)](package.json)
+[![GitHub Marketplace](https://img.shields.io/badge/Marketplace-DocGuard-blue?logo=github)](https://github.com/marketplace/actions/docguard-cdd-compliance)
 
 ---
 
@@ -30,23 +32,43 @@
 
 ```bash
 # The primary command — AI diagnoses AND fixes everything
-npx docguard diagnose
+npx docguard-cli diagnose
 
 # Generate CDD docs from an existing codebase
-npx docguard generate
+npx docguard-cli generate
 
 # Start from scratch (minimal setup for side projects)
-npx docguard init --profile starter
+npx docguard-cli init --profile starter
 
 # Start from scratch (full enterprise setup)
-npx docguard init
+npx docguard-cli init
 
 # CI gate — pass/fail for pipelines
-npx docguard guard
+npx docguard-cli guard
 ```
 
 No installation needed. Zero dependencies. Works with Node.js 18+.
 
+### Install
+
+```bash
+# Run directly (no install)
+npx docguard-cli diagnose
+
+# Or install globally
+npm i -g docguard-cli
+docguard diagnose
+```
+
+### GitHub Action
+
+```yaml
+- uses: raccioly/docguard@v0.5.0
+  with:
+    command: guard
+    fail-on-warning: true
+```
+
 ### The AI Loop
 
 ```
@@ -63,7 +85,7 @@ diagnose  →  AI reads prompts  →  AI fixes docs  →  guard verifies
 
 ### 🔮 Generate — Reverse-engineer docs from code
 ```
-$ npx docguard generate
+$ npx docguard-cli generate
 
 🔮 DocGuard Generate — my-project
    Scanning codebase to generate canonical documentation...
@@ -93,7 +115,7 @@ $ npx docguard generate
 
 ### 📊 Score — CDD maturity assessment
 ```
-$ npx docguard score
+$ npx docguard-cli score
 
   Category Breakdown
 
@@ -115,7 +137,7 @@ $ npx docguard score
 
 ### 🔍 Diff — Canonical docs vs code comparison
 ```
-$ npx docguard diff
+$ npx docguard-cli diff
 
   🛣️ API Routes
     In code but not documented:
@@ -130,7 +152,7 @@ $ npx docguard diff
 
 ### 🤖 Agents — Generate agent-specific configs
 ```
-$ npx docguard agents
+$ npx docguard-cli agents
 
   ✅ Cursor: .cursor/rules/cdd.mdc
   ✅ GitHub Copilot: .github/copilot-instructions.md
@@ -144,21 +166,21 @@ $ npx docguard agents
 
 ### 🔍 Audit — What docs exist/missing
 ```
-$ npx docguard audit
+$ npx docguard-cli audit
 
   Score: 8/8 required files (100%)
 ```
 
 ### 🏗️ Init — Create CDD docs from templates
 ```
-$ npx docguard init
+$ npx docguard-cli init
 
   Created 9 files (8 docs + .docguard.json)
 ```
 
 ### 🛡️ Guard — Validate project against docs
 ```
-$ npx docguard guard
+$ npx docguard-cli guard
 
   ✅ Structure      8/8 checks passed
   ✅ Doc Sections   10/10 checks passed
@@ -261,8 +283,8 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: '20'
-      - run: npx docguard guard
-      - run: npx docguard score --format json
+      - run: npx docguard-cli guard
+      - run: npx docguard-cli score --format json
 ```
 
 ### Pre-commit Hook
@@ -270,7 +292,7 @@ jobs:
 ```bash
 # .git/hooks/pre-commit
 #!/bin/sh
-npx docguard guard
+npx docguard-cli guard
 ```
 
 ---

package/docs/ai-integration.md

@@ -39,7 +39,7 @@ DocGuard works with any AI coding agent that can read CLI output:
 ### Step 1: Diagnose
 
 ```bash
-npx docguard diagnose
+npx docguard-cli diagnose
 ```
 
 Output:
@@ -66,7 +66,7 @@ Output:
 The AI reads the remediation plan and executes `docguard fix --doc <name>` for each issue. Each fix command outputs research instructions:
 
 ```bash
-npx docguard fix --doc architecture
+npx docguard-cli fix --doc architecture
 ```
 
 Output:
@@ -90,7 +90,7 @@ WRITE THE DOCUMENT:
 ### Step 3: Verify
 
 ```bash
-npx docguard guard
+npx docguard-cli guard
 ```
 
 If all checks pass → done. If issues remain → repeat from Step 1.
@@ -100,7 +100,7 @@ If all checks pass → done. If issues remain → repeat from Step 1.
 For programmatic integration:
 
 ```bash
-npx docguard diagnose --format json
+npx docguard-cli diagnose --format json
 ```
 
 ```json
@@ -124,7 +124,7 @@ npx docguard diagnose --format json
 ```
 
 ```bash
-npx docguard guard --format json
+npx docguard-cli guard --format json
 ```
 
 ```json
@@ -157,7 +157,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with: { node-version: '20' }
-      - run: npx docguard ci --format json --threshold 70
+      - run: npx docguard-cli ci --format json --threshold 70
 ```
 
 Or copy `templates/ci/github-actions.yml` from this repo.
@@ -165,7 +165,7 @@ Or copy `templates/ci/github-actions.yml` from this repo.
 ### Pre-commit Hook
 
 ```bash
-npx docguard hooks
+npx docguard-cli hooks
 ```
 
 Automatically runs `guard` before every commit.

package/docs/commands.md

@@ -19,9 +19,9 @@ diagnose (identify + fix)  →  AI executes  →  guard (verify)
 **The AI orchestrator.** Runs all validators, maps every failure to an AI fix prompt, outputs a remediation plan.
 
 ```bash
-npx docguard diagnose                # Human-readable remediation plan
-npx docguard diagnose --format json  # Structured for automation
-npx docguard diagnose --format prompt # Raw AI prompt (all issues combined)
+npx docguard-cli diagnose                # Human-readable remediation plan
+npx docguard-cli diagnose --format json  # Structured for automation
+npx docguard-cli diagnose --format prompt # Raw AI prompt (all issues combined)
 ```
 
 **JSON output includes:**
@@ -35,9 +35,9 @@ npx docguard diagnose --format prompt # Raw AI prompt (all issues combined)
 **Identify issues.** Validate project against canonical docs. Use for CI gates and pre-commit hooks.
 
 ```bash
-npx docguard guard                   # Text output
-npx docguard guard --format json     # Structured JSON
-npx docguard guard --verbose         # Show all check details
+npx docguard-cli guard                   # Text output
+npx docguard-cli guard --format json     # Structured JSON
+npx docguard-cli guard --verbose         # Show all check details
 ```
 
 **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
 **CDD maturity score** (0-100) with category breakdown.
 
 ```bash
-npx docguard score                   # Visual bar chart
-npx docguard score --format json     # Structured JSON
-npx docguard score --tax             # Documentation tax estimate
+npx docguard-cli score                   # Visual bar chart
+npx docguard-cli score --format json     # Structured JSON
+npx docguard-cli score --tax             # Documentation tax estimate
 ```
 
 **`--tax` output:**
@@ -89,11 +89,11 @@ Tax-to-value ratio:  LOW
 **Initialize CDD documentation** from templates.
 
 ```bash
-npx docguard init                           # Full CDD (standard profile)
-npx docguard init --profile starter         # Minimal: ARCHITECTURE + CHANGELOG
-npx docguard init --profile enterprise      # Everything + strict validators
-npx docguard init --dir /path/to/project    # Specify directory
-npx docguard init --skip-prompts            # No AI prompt output
+npx docguard-cli init                           # Full CDD (standard profile)
+npx docguard-cli init --profile starter         # Minimal: ARCHITECTURE + CHANGELOG
+npx docguard-cli init --profile enterprise      # Everything + strict validators
+npx docguard-cli init --dir /path/to/project    # Specify directory
+npx docguard-cli init --skip-prompts            # No AI prompt output
 ```
 
 **Profiles:**
@@ -109,8 +109,8 @@ npx docguard init --skip-prompts            # No AI prompt output
 **Reverse-engineer docs from existing code.** Scans your codebase and creates pre-filled documentation.
 
 ```bash
-npx docguard generate
-npx docguard generate --dir /path/to/project
+npx docguard-cli generate
+npx docguard-cli generate --dir /path/to/project
 ```
 
 **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
 **Scan and report** which CDD documents exist, are missing, or need attention.
 
 ```bash
-npx docguard audit
+npx docguard-cli audit
 ```
 
 ---
@@ -132,10 +132,10 @@ npx docguard audit
 **Find issues and generate AI fix instructions.**
 
 ```bash
-npx docguard fix                    # Human-readable issue list
-npx docguard fix --format json      # Machine-readable for VS Code/CI
-npx docguard fix --format prompt    # AI-ready prompt
-npx docguard fix --auto             # Create missing skeleton files
+npx docguard-cli fix                    # Human-readable issue list
+npx docguard-cli fix --format json      # Machine-readable for VS Code/CI
+npx docguard-cli fix --format prompt    # AI-ready prompt
+npx docguard-cli fix --auto             # Create missing skeleton files
 ```
 
 ### `docguard fix --doc <name>`
@@ -143,11 +143,11 @@ npx docguard fix --auto             # Create missing skeleton files
 **Generate a deep AI research prompt** for a specific document.
 
 ```bash
-npx docguard fix --doc architecture
-npx docguard fix --doc data-model
-npx docguard fix --doc security
-npx docguard fix --doc test-spec
-npx docguard fix --doc environment
+npx docguard-cli fix --doc architecture
+npx docguard-cli fix --doc data-model
+npx docguard-cli fix --doc security
+npx docguard-cli fix --doc test-spec
+npx docguard-cli fix --doc environment
 ```
 
 **Output includes:** TASK, PURPOSE, RESEARCH STEPS (what to grep/read), WRITE THE DOCUMENT (expected sections).
@@ -157,8 +157,8 @@ npx docguard fix --doc environment
 **Generate agent-specific config files** from AGENTS.md.
 
 ```bash
-npx docguard agents
-npx docguard agents --list
+npx docguard-cli agents
+npx docguard-cli agents --list
 ```
 
 ---
@@ -170,10 +170,10 @@ npx docguard agents --list
 **Single command for CI/CD pipelines.** Runs guard + score internally (no subprocess).
 
 ```bash
-npx docguard ci                              # Basic check
-npx docguard ci --threshold 70               # Fail below score 70
-npx docguard ci --threshold 80 --fail-on-warning  # Strict mode
-npx docguard ci --format json                # JSON for GitHub Actions
+npx docguard-cli ci                              # Basic check
+npx docguard-cli ci --threshold 70               # Fail below score 70
+npx docguard-cli ci --threshold 80 --fail-on-warning  # Strict mode
+npx docguard-cli ci --format json                # JSON for GitHub Actions
 ```
 
 ### `docguard hooks`
@@ -181,9 +181,9 @@ npx docguard ci --format json                # JSON for GitHub Actions
 **Install git hooks** for automatic validation.
 
 ```bash
-npx docguard hooks              # Install all hooks
-npx docguard hooks --list       # Show installed hooks
-npx docguard hooks --remove     # Remove hooks
+npx docguard-cli hooks              # Install all hooks
+npx docguard-cli hooks --list       # Show installed hooks
+npx docguard-cli hooks --remove     # Remove hooks
 ```
 
 **Hooks installed:**
@@ -196,8 +196,8 @@ npx docguard hooks --remove     # Remove hooks
 **Live watch mode** — re-runs guard on file changes.
 
 ```bash
-npx docguard watch              # Watch and re-run guard
-npx docguard watch --auto-fix   # Also output AI fix prompts on failure
+npx docguard-cli watch              # Watch and re-run guard
+npx docguard-cli watch --auto-fix   # Also output AI fix prompts on failure
 ```
 
 ### `docguard badge`
@@ -205,8 +205,8 @@ npx docguard watch --auto-fix   # Also output AI fix prompts on failure
 **Generate shields.io badges** for README.
 
 ```bash
-npx docguard badge
-npx docguard badge --format json
+npx docguard-cli badge
+npx docguard-cli badge --format json
 ```
 
 ### `docguard diff`
@@ -214,7 +214,7 @@ npx docguard badge --format json
 **Show gaps** between documentation and actual codebase.
 
 ```bash
-npx docguard diff
+npx docguard-cli diff
 ```
 
 ---

package/docs/faq.md

@@ -110,7 +110,7 @@ If tax is HIGH, consider using `starter` profile or letting AI handle more.
 ### How do I add DocGuard to CI?
 
 ```bash
-npx docguard ci --format json --threshold 70
+npx docguard-cli ci --format json --threshold 70
 ```
 
 Exit code 0 = pass, 1 = fail. Use `--threshold` to set minimum score.

package/docs/profiles.md

@@ -11,7 +11,7 @@ Requiring all 5 canonical docs for a weekend side project is overkill. Requiring
 ### `starter` — For side projects and prototypes
 
 ```bash
-npx docguard init --profile starter
+npx docguard-cli init --profile starter
 ```
 
 **Creates:** ARCHITECTURE.md, CHANGELOG.md, AGENTS.md, DRIFT-LOG.md
@@ -25,8 +25,8 @@ npx docguard init --profile starter
 ### `standard` — For team projects (default)
 
 ```bash
-npx docguard init                    # default profile
-npx docguard init --profile standard # explicit
+npx docguard-cli init                    # default profile
+npx docguard-cli init --profile standard # explicit
 ```
 
 **Creates:** All 5 canonical docs + AGENTS.md + CHANGELOG.md + DRIFT-LOG.md
@@ -40,7 +40,7 @@ npx docguard init --profile standard # explicit
 ### `enterprise` — For regulated and critical projects
 
 ```bash
-npx docguard init --profile enterprise
+npx docguard-cli init --profile enterprise
 ```
 
 **Creates:** All 5 canonical docs + all tracking files
@@ -54,7 +54,7 @@ npx docguard init --profile enterprise
 ### At init time
 
 ```bash
-npx docguard init --profile starter
+npx docguard-cli init --profile starter
 ```
 
 ### In `.docguard.json`
@@ -97,7 +97,7 @@ Change the `"profile"` field in `.docguard.json` and run `docguard diagnose` to
 ## Measuring the Cost
 
 ```bash
-npx docguard score --tax
+npx docguard-cli score --tax
 ```
 
 Shows estimated weekly maintenance time. If the tax is HIGH, consider downgrading your profile. If LOW, you might benefit from upgrading.

package/docs/quickstart.md

@@ -8,7 +8,7 @@ Get AI-enforced documentation in under 5 minutes.
 
 ```bash
 cd your-project
-npx docguard init --profile starter
+npx docguard-cli init --profile starter
 ```
 
 Creates only ARCHITECTURE.md + CHANGELOG — the bare minimum.
@@ -17,7 +17,7 @@ Creates only ARCHITECTURE.md + CHANGELOG — the bare minimum.
 
 ```bash
 cd your-project
-npx docguard init
+npx docguard-cli init
 ```
 
 Creates all 5 canonical docs + tracking files + AI slash commands.
@@ -26,7 +26,7 @@ Creates all 5 canonical docs + tracking files + AI slash commands.
 
 ```bash
 cd your-project
-npx docguard generate
+npx docguard-cli generate
 ```
 
 Scans your codebase and generates pre-filled documentation.
@@ -36,7 +36,7 @@ Scans your codebase and generates pre-filled documentation.
 After init creates skeleton templates, run **one command**:
 
 ```bash
-npx docguard diagnose
+npx docguard-cli diagnose
 ```
 
 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
 ## Verify
 
 ```bash
-npx docguard guard        # Pass/fail check
-npx docguard score        # 0-100 maturity score
-npx docguard score --tax  # How much time docs cost you
+npx docguard-cli guard        # Pass/fail check
+npx docguard-cli score        # 0-100 maturity score
+npx docguard-cli score --tax  # How much time docs cost you
 ```
 
 ## Automate
 
 ```bash
 # Git hooks (auto-check on commit/push)
-npx docguard hooks
+npx docguard-cli hooks
 
 # CI/CD pipelines
-npx docguard ci --threshold 70
+npx docguard-cli ci --threshold 70
 
 # Live watch mode with auto-fix
-npx docguard watch --auto-fix
+npx docguard-cli watch --auto-fix
 ```
 
 ## What's Next?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docguard-cli",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "The enforcement tool for Canonical-Driven Development (CDD). Audit, generate, and guard your project documentation.",
   "type": "module",
   "bin": {

package/templates/ci/github-actions.yml

@@ -21,7 +21,7 @@ jobs:
           node-version: '20'
 
       - name: Run DocGuard CI
-        run: npx docguard ci --format json --threshold 70 > docguard-report.json
+        run: npx docguard-cli ci --format json --threshold 70 > docguard-report.json
 
       - name: Display Results
         if: always()