From claudient
Generates API reference documentation for public-facing modules, HTTP endpoints, and CLI interfaces by scanning source code exports, route definitions, and argument parsers, outputting structured Markdown.
How this command is triggered — by the user, by Claude, or both
Slash command
/claudient:api-docs [file-or-directory]docs/The summary Claude sees in its command listing — used to decide when to auto-load this command
Generate complete API reference documentation for: $ARGUMENTS If no argument is given, scan the repo for public API surfaces — exported modules, REST/GraphQL endpoints, CLI interfaces — and document all of them. Process: 1. Identify the API surface: - For libraries: exported functions, classes, types (read source + any index/barrel files). - For HTTP APIs: route definitions (Express, FastAPI, Django, Rails, etc.). - For CLIs: argument parsers (argparse, click, cobra, yargs, etc.). 2. For each public symbol/endpoint, extract: name, signature/route+method, parameters with types, re...
Generate complete API reference documentation for: $ARGUMENTS
If no argument is given, scan the repo for public API surfaces — exported modules, REST/GraphQL endpoints, CLI interfaces — and document all of them.
Process:
Output format — Markdown reference document:
For each module / namespace / route group:
<SymbolName> / <METHOD /path>Description: What it does (inferred from implementation if no docstring exists).
Parameters / Request:
| Name | Type | Required | Description |
|---|---|---|---|
| ... | ... | ... | ... |
Returns / Response: type and shape, or HTTP status codes with body shape.
Errors: List known error conditions and their codes/types.
Example:
// minimal working example
Rules:
<!-- verify -->.Write the output to docs/api-reference.md (create docs/ if absent), or to $ARGUMENTS if it ends in .md. Confirm the path written.
npx claudepluginhub claudient/claudient --plugin claudient-personas/api-docsGenerates API documentation from route definitions and handlers in web frameworks like Express, FastAPI, Gin, and Actix. Extracts schemas, auth, examples; outputs Markdown or OpenAPI to docs/api/.
/api-docsGenerates API reference docs from source code: scans routes/types/annotations, documents endpoints with params/schemas/responses/examples/auth, organizes by resource, adds operational details.
/api-docsGenerates OpenAPI 3.1 spec and Postman collection from plan.md API contracts. Auto-detects framework, validates spec-implementation consistency, outputs publishable docs.