generate-docs

generate-docs is a command for Claude Code from rohitg00/awesome-claude-code-toolkit. It costs 0 tokens per session (642 once invoked), scanned A, original, Apache-2.0.

A command that creates documentation for a project or module by examining its structure, public interfaces, dependencies, and existing comments. It can describe modules, functions, methods, types, errors, examples, and edge cases.

In plain words
What is it for?
Use it to document a project’s architecture and public API, including parameters, return values, exceptions, usage examples, and boundary behavior.
Why use it?
It turns scattered source-code details into reference material that helps developers understand and use the project.

Command for Claude Code

Written for Claude Code: shipped in a Claude Code plugin.

Part of the doc-forge plugin — 2 commands shipped together

Good fit Use it to document a project’s architecture and public API, including parameters, return values, exceptions, usage examples, and boundary behavior.

Compare 6 commands from other repositories ↓
Install with agentmods
npx agentmods add commands/rohitg00/awesome-claude-code-toolkit/generate-docs
About the project

Awesome Claude Code Toolkit is a curated collection of extensions and configuration for Claude Code, including agents, skills, commands, plugins, hooks, rules, templates, MCP configurations, and companion apps. It is for Claude Code users who want ready-made workflows and integrations for different development tasks. The catalogue add-ons are selected components from this toolkit.

rohitg00/awesome-claude-code-toolkit · 2,595 stars · on GitHub

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Clone the repo
git clone --depth 1 https://github.com/rohitg00/awesome-claude-code-toolkit

Made for: Claude Code.

Or install doc-forge, the plugin that ships this one along with the rest of its 2 commands.

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 generate-docs

README.md
[![agentmods](https://agentmods.dev/badge/commands/rohitg00/awesome-claude-code-toolkit/generate-docs.svg)](https://agentmods.dev/commands/rohitg00/awesome-claude-code-toolkit/generate-docs)
Your own site
<a href="https://agentmods.dev/commands/rohitg00/awesome-claude-code-toolkit/generate-docs"><img src="https://agentmods.dev/badge/commands/rohitg00/awesome-claude-code-toolkit/generate-docs.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 642 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.00642
Opus 5 $0.00000 $0.00321
Sonnet 5 $0.00000 $0.00128
Haiku 4.5 $0.00000 $0.00064

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

Security

Grade A, and why

generate-docs 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 3d 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.

plugins/doc-forge/commands/generate-docs.md · 69 lines

How it starts

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

/doc-forge:generate-docs

Generate comprehensive documentation for the current project or a specified module.

Process

  1. Survey the project to understand its architecture:

    • Read the entry point (main.ts, index.js, app.py, main.go, src/lib.rs)
    • Identify the module structure and public API surface
    • Check for existing documentation (docs/ directory, JSDoc, docstrings, rustdoc)
    • Read package.json, pyproject.toml, or Cargo.toml for project metadata
  2. Generate documentation for each public module:

Module Overview

  • Purpose: one paragraph explaining what this module does and when to use it
  • Dependencies: what this module requires and what depends on it
  • Architecture notes: key design decisions and patterns used

Function/Method Documentation

  • For each exported function, document:
    • Purpose in one sentence
    • Parameters with types, descriptions, and default values
    • Return type and description
    • Exceptions/errors that can be thrown and under what conditions
    • Usage example showing the most common invocation
    • Edge cases: behavior with null inputs, empty collections, boundary values

Type/Interface Documentation

  • For each exported type, document:
    • Purpose and when to use this type
    • Each field with its type, description, and constraints
    • Relationships to other types (extends, implements, references)
    • Construction patterns (factory functions, builders, constructors)

Configuration Documentation

  • Environment variables with descriptions, types, defaults, and required/optional status
  • Configuration file formats with annotated examples
  • Feature flags and their effects on behavior
  1. Generate usage examples:

    • Quick start: minimal code to get the module working
    • Common patterns: 3-5 typical use cases with complete code snippets
    • Advanced usage: composition with other modules, custom configuration
    • Error handling: how to properly handle failures from this module
  2. Create a table of contents linking all documented modules.

Read the full file on GitHub · 69 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. 3d ago First seen · 69 lines · 0 tokens per session scan A dba60ae450fd

Subscribe to this mod's changes

generate-docs is a command published in the GitHub repository rohitg00/awesome-claude-code-toolkit (2,595 stars, last pushed 3mo ago), licensed Apache-2.0. It costs nothing until one of its globs matches a file; then it loads 642 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-09-03.