{
 "schema_version": 1,
 "generated": "2026-10-26",
 "id": "sakanaai-autoillustrate--diagram-code-architecture-from-project",
 "repo": "SakanaAI/AutoIllustrate",
 "repo_url": "https://github.com/SakanaAI/AutoIllustrate",
 "repo_slug": "sakanaai-autoillustrate",
 "title": "Diagram a code architecture from a project directory",
 "page_title": "How to diagram a code architecture from a project directory with Auto Illustrate",
 "summary": "Point the tool at a folder of .tex, .md, .py and .txt files to draw a scoped architecture figure.",
 "who": "A developer or research engineer who needs an architecture figure for a README, report or paper and has the source files in one folder.",
 "problem": "Architecture diagrams go stale quickly, and drawing them by hand from a large codebase is slow.",
 "outcome": "An editable architecture diagram of the scoped subsystem, plus a restyled PNG, in a new run folder.",
 "steps": [
  "Install the draw.io desktop CLI, the Claude Code CLI, and set OPENAI_API_KEY. (inferred, check the README)",
  "`npm install -g autoillustrate`",
  "`autoillustrate ./sources_bundle/ --prompt \"Please make a diagram illustrating the code architecture.\"` (replace the folder with your project directory and narrow the prompt to one subsystem) (inferred, check the README)",
  "Open the newest run folder and review figures/full_figure.drawio before sharing the PNG."
 ],
 "agent_prompt": "Using the repo SakanaAI/AutoIllustrate, run autoillustrate on the project directory <path to project> with a prompt naming one subsystem to diagram. Verify that the run's figures/ folder contains full_figure.drawio and report which files were read and any missing components.",
 "agents": [
  "claude-code"
 ],
 "difficulty": "Intermediate",
 "time": "1 hour",
 "basis": "readme",
 "caveat": "The README describes the tool as reading .tex, .md, .py and .txt files, so other file types are not covered by the stated behavior.",
 "category": "Research",
 "tags": [
  "Research"
 ],
 "lang": "typescript",
 "requirements": [
  "Node 22 or newer",
  "draw.io desktop CLI on PATH as drawio",
  "Claude Code CLI (claude) on PATH, since it is the default agent",
  "OPENAI_API_KEY set in the shell or a .env file",
  "Python 3.10 or newer (the CLI creates its own cached venv on first run)"
 ],
 "risk": "none",
 "seen_in_the_wild": false,
 "mentioned_publicly": false,
 "risks": [
  {
   "tag": "credentials",
   "notice": "The tool reads your project files and launches coding agents with your inherited environment, so point it only at code you trust and keep secrets out of the folder."
  }
 ],
 "best": false,
 "score": 0.7,
 "evidence": [],
 "url": "https://dedupedai.com/use-cases/sakanaai-autoillustrate/diagram-code-architecture-from-project/",
 "md": "https://dedupedai.com/use-cases/sakanaai-autoillustrate/diagram-code-architecture-from-project/index.md",
 "disclaimer": "Deduped lists open-source repositories that belong to other people. We do not own, maintain, audit, or vouch for any of them, and a repo appearing here is not an endorsement or a safety check. The use cases, steps, and prompts are written by AI and may be incomplete, outdated, or just wrong. Where a use case is marked \"Seen in the wild\", we link to public posts where someone described something similar, but we have not verified those posts and the use case itself is still our AI's own write-up. Use all of this at your own risk. Only run code, commands, or agents on systems and accounts you are authorized to use, and read the code and every command before you run it, especially anything that touches credentials, files, or the network. Nothing here is professional, security, legal, or financial advice. All trademarks and project names belong to their respective owners, and their use here does not imply affiliation. Content is provided as is, without warranties of any kind. Found a mistake, a safety problem, or something you want removed? Email hello@dedupedai.com and we will look at it promptly.",
 "api": "https://dedupedai.com/api/v1/usecases/sakanaai-autoillustrate--diagram-code-architecture-from-project.json",
 "api_version": "v1"
}