Skip to content

docs(cli): add missing subcommands to quick references #397

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Alberto-Codes merged 1 commit into from
Mar 27, 2026
Merged

docs(cli): add missing subcommands to quick references #397

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Loading