diff --git a/CLAUDE.md b/CLAUDE.md index 38dc1e9..c7a1bf7 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -48,10 +48,17 @@ uv run pytest --cov=docvet --cov-report=term-missing # With coverage docvet check # Run all checks on git diff files docvet check --staged # Run checks on staged files docvet check --all # Run checks on entire codebase +docvet presence # Run presence check only docvet enrichment # Run enrichment check only docvet freshness # Run freshness check only +docvet freshness --mode drift # Run freshness drift sweep via git blame docvet coverage # Run coverage check only docvet griffe # Run griffe compatibility check only +docvet fix # Scaffold missing docstring sections +docvet fix --dry-run # Preview scaffolding without writing files +docvet config # Show effective configuration +docvet lsp # Start LSP server for editor diagnostics +docvet mcp # Start MCP server for AI agents ``` ## Architecture diff --git a/README.md b/README.md index 6db3a1e..d283b3e 100644 --- a/README.md +++ b/README.md @@ -160,8 +160,14 @@ fail-on = ["enrichment", "freshness", "coverage", "griffe"] | `docvet presence` | Check for missing docstrings with coverage metrics | | `docvet enrichment` | Check for missing docstring sections | | `docvet freshness` | Detect stale docstrings via git | +| `docvet freshness --mode drift` | Sweep for long-stale docstrings via git blame | | `docvet coverage` | Find files invisible to mkdocs | | `docvet griffe` | Check mkdocs rendering compatibility | +| `docvet fix` | Scaffold missing docstring sections | +| `docvet fix --dry-run` | Preview scaffolding changes without writing files | +| `docvet config` | Show effective configuration with source annotations | +| `docvet lsp` | Start LSP server for real-time editor diagnostics | +| `docvet mcp` | Start MCP server for AI agent integration | ## Better Docstrings, Better AI