Skip to main content
Category: Developer Tools · Version: 1.0.0 · Author: OpenDirectory · Compatibility: All targets (claude, codex, opencode, gemini, anti-gravity, openclaw, hermes)
docs-from-code Automatically generate and maintain README.md, API reference docs, and an Architecture section by reading your codebase. Uses graphify to build a knowledge graph first, then uses AI to write clean documentation grounded in what actually exists.

Install

What It Generates

Why graphify?

The skill uses graphify as its extraction engine:
  • 20 languages via tree-sitter AST: Python, TypeScript, Go, Rust, Java, and 15 more
  • Architecture insight: god nodes and community clusters show what everything connects through
  • 71.5x fewer tokens than reading raw files, efficient on large codebases
  • SHA256 cache: re-runs only process changed files
  • Honest tagging: EXTRACTED (found in source) vs INFERRED (reasonable inference with confidence score)
  • Extracts rationale from # NOTE:, # WHY:, # HACK: comments and docstrings
The bundled scripts/ (TypeScript and Python AST extractors) serve as a fallback if graphify is unavailable.

Supported Languages (via graphify)

Python, TypeScript, JavaScript, Go, Rust, Java, C, C++, Ruby, C#, Kotlin, Scala, PHP, Swift, Lua, Zig, PowerShell, Elixir, Objective-C, Julia

Requirements

  • Python 3.10+ (for graphify)
  • Node.js 18+ (for fallback TypeScript extractor)
  • gh CLI (optional, for opening PRs automatically)
  • GITHUB_TOKEN env var (optional, for PRs)

Setup

1. Set up graphify

No API keys needed for extraction. graphify uses your agent’s existing model access.

2. Configure (Optional)

How to Use

Be inside your project and ask:
The agent will:
  1. Run graphify . --no-viz to build a knowledge graph of your codebase
  2. Read GRAPH_REPORT.md for god nodes, communities, and architecture insights
  3. Query the graph for routes, types, and data models
  4. Read existing docs to understand what needs updating
  5. Generate accurate docs grounded in the graph
  6. Write files and optionally open a GitHub PR

Project Structure

License

MIT