DocGuard — Quick Start

Get AI-enforced documentation in under 5 minutes.

For New Projects

Option A: Minimal (side projects) 

cd your-project
npx docguard-cli init --profile starter

Creates only ARCHITECTURE.md + CHANGELOG — the bare minimum.

Option B: Full CDD (team projects) 

cd your-project
npx docguard-cli init

Creates all 6 canonical docs (including REQUIREMENTS.md) + tracking files + AI slash commands.

Option C: Spec-Driven Development (spec-kit projects)

If you’re using GitHub Spec Kit:

# 1. Initialize Spec Kit for your agent
specify init --here --integration claude

# 2. Add DocGuard: init registers its Spec Kit extension
npx docguard-cli init

# 3. Write specs with AI, validate with DocGuard
/speckit.specify Build an app that...
npx docguard-cli guard

Option D: From existing code (established projects) 

cd your-project
npx docguard-cli generate

Scans your codebase and generates pre-filled documentation, including REQUIREMENTS.md with spec-kit-aligned FR/SC IDs.

Fill the Docs (AI Does It)

After init creates skeleton templates, run one command:

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.

That’s it. The AI loop:

diagnose  →  AI reads prompts  →  AI fixes docs  →  guard verifies
   ↑                                                       ↓
   └───────────────── issues found? ←──────────────────────┘

Verify 

npx docguard-cli guard        # Pass/fail check (34 validators)
npx docguard-cli score        # 0-100 maturity score

Automate 

# Git hooks (auto-check on commit/push)
npx docguard-cli hooks

# CI/CD pipelines
npx docguard-cli ci --threshold 70

# Live watch mode
npx docguard-cli watch --auto-fix

What’s Next?