doc-generate

doc-generate is a command for Claude Code from thapaliyabikendra/ai-artifacts. It costs 0 tokens per session (825 once invoked), scanned A, original, Apache-2.0.

A documentation tool that reads a codebase and creates or updates technical and user-facing documents. It can cover API details, system structure, code usage, setup, troubleshooting, and guides.

In plain words
What is it for?
Use it to generate API specifications and interactive API pages, architecture diagrams, README files, configuration notes, tutorials, FAQs, and troubleshooting guides.
Why use it?
It reduces the manual work of explaining code and helps keep documentation aligned with the implementation. It also gives different kinds of project information a consistent structure.

Command for Claude Code

Written for Claude Code: $ARGUMENTS substitution. Also seen: reads .claude/ paths.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is run: python scripts/generate_openapi.py.

Good fit Use it to generate API specifications and interactive API pages, architecture diagrams, README files, configuration notes, tutorials, FAQs, and troubleshooting guides.

Compare 6 commands from other repositories ↓
Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/thapaliyabikendra/ai-artifacts
agentmods
npx agentmods add commands/thapaliyabikendra/ai-artifacts/doc-generate

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for doc-generate

README.md
[![agentmods](https://agentmods.dev/badge/commands/thapaliyabikendra/ai-artifacts/doc-generate.svg)](https://agentmods.dev/commands/thapaliyabikendra/ai-artifacts/doc-generate)
Your own site
<a href="https://agentmods.dev/commands/thapaliyabikendra/ai-artifacts/doc-generate"><img src="https://agentmods.dev/badge/commands/thapaliyabikendra/ai-artifacts/doc-generate.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 825 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00000 $0.00825
Opus 5 $0.00000 $0.00413
Sonnet 5 $0.00000 $0.00165
Haiku 4.5 $0.00000 $0.00082

Measured 7d ago against content hash 66a117d9f15d, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-07, from the pricing page.

Security

Grade A, and why

doc-generate scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 7d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.claude/commands/generate/doc-generate.md · 175 lines

How it starts

The opening of the file, as written. The whole thing — 175 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Automated Documentation Generation

You are a documentation expert specializing in creating comprehensive, maintainable documentation from code.

Context

The user needs automated documentation generation that extracts information from code, creates clear explanations, and maintains consistency. Focus on creating living documentation synchronized with code.

Requirements

$ARGUMENTS

Documentation Types

1. API Documentation

Generate from code analysis:

  • Extract endpoint definitions, parameters, responses
  • Generate OpenAPI/Swagger specifications
  • Create interactive docs (Swagger UI, Redoc)
  • Include authentication, rate limiting, error handling

2. Architecture Documentation

Create visual representations:

  • System architecture diagrams (Mermaid)
  • Component relationships and data flows
  • Service dependencies
  • Scalability considerations

3. Code Documentation

  • Inline documentation and docstrings
  • README files with setup/usage/contribution
  • Configuration options and env variables
  • Troubleshooting guides

4. User Documentation

  • Step-by-step user guides
  • Getting started tutorials
  • Common workflows and use cases
  • FAQ and troubleshooting

Extraction Process

  1. Parse source code

    • Extract function signatures and docstrings
    • Identify route decorators and endpoints
    • Find Pydantic/DTO schemas
  2. Generate schemas

    • OpenAPI from route definitions
    • JSON Schema from data models
    • TypeScript types from schemas
  3. Create diagrams

    graph TB
        subgraph "API Layer"
            Gateway[API Gateway]
            Auth[Auth Service]
        end
        subgraph "Services"
            User[User Service]
            Order[Order Service]
        end
        Gateway --> Auth
        Gateway --> User
        Gateway --> Order
    
  4. Build documentation site

    • Combine all artifacts
    • Add navigation and search
    • Deploy to hosting platform

Output Artifacts

Type Format Tool
API Spec OpenAPI 3.0 Code extraction
Interactive API HTML Swagger UI/Redoc
Architecture Mermaid Diagram generation
Code Docs Markdown/HTML Sphinx/TypeDoc
User Guide Markdown Manual + templates

Read the full file on GitHub · 175 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 7d ago First seen · 175 lines · 0 tokens per session scan A 66a117d9f15d

Subscribe to this mod's changes

doc-generate is a command published in the GitHub repository thapaliyabikendra/ai-artifacts (24 stars, last pushed 5mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 825 tokens. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.