{"id":30522912,"url":"https://github.com/leojkwan/claudux","last_synced_at":"2026-04-19T02:03:38.647Z","repository":{"id":309297052,"uuid":"1032034063","full_name":"leojkwan/claudux","owner":"leojkwan","description":"AI-powered documentation generator for your codebase using Claude Code and VitePress","archived":false,"fork":false,"pushed_at":"2025-08-26T14:17:59.000Z","size":515,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-26T17:10:37.235Z","etag":null,"topics":["ai","anthropic","claude","claude-code","cleanup","cli","developer-tools","doc-generator","docs","documentation","link-check","static-site","vitepress"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/claudux","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leojkwan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-04T17:45:49.000Z","updated_at":"2025-08-26T14:18:03.000Z","dependencies_parsed_at":"2025-08-26T16:09:51.407Z","dependency_job_id":"72600c29-47f3-4ffb-b000-003351e26d83","html_url":"https://github.com/leojkwan/claudux","commit_stats":null,"previous_names":["leojkwan/claudux"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/leojkwan/claudux","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leojkwan%2Fclaudux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leojkwan%2Fclaudux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leojkwan%2Fclaudux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leojkwan%2Fclaudux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leojkwan","download_url":"https://codeload.github.com/leojkwan/claudux/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leojkwan%2Fclaudux/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272250296,"owners_count":24900184,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","anthropic","claude","claude-code","cleanup","cli","developer-tools","doc-generator","docs","documentation","link-check","static-site","vitepress"],"created_at":"2025-08-26T19:43:01.854Z","updated_at":"2026-04-19T02:03:38.642Z","avatar_url":"https://github.com/leojkwan.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/claudux-banner.svg\" alt=\"claudux — production-ready docs from your code\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/claudux\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/claudux.svg?style=flat\u0026color=8b5cf6\" alt=\"npm version\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/claudux\"\u003e\u003cimg src=\"https://img.shields.io/npm/dm/claudux?style=flat\" alt=\"npm downloads\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/leojkwan/claudux/stargazers\"\u003e\u003cimg src=\"https://img.shields.io/github/stars/leojkwan/claudux?style=flat\" alt=\"GitHub stars\" /\u003e\u003c/a\u003e\n  \u003ca href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-MIT-yellow.svg\" alt=\"License: MIT\" /\u003e\u003c/a\u003e\n  \u003cimg src=\"https://img.shields.io/node/v/claudux?style=flat\" alt=\"Node version\" /\u003e\n\u003c/p\u003e\n\n# claudux\n\nDocumentation generator that uses AI to analyze your codebase and create VitePress sites. Supports multiple AI backends.\n\n\u003e **See it in action:** [Live documentation](https://leojkwan.github.io/claudux/) (generated by claudux itself)\n\n## Install\n\n```bash\nnpm install -g claudux\n```\n\n**Requirements:** Node \u003e=18, an authenticated AI CLI ([Claude CLI](https://docs.anthropic.com/claude/docs/claude-cli) or [Codex CLI](https://github.com/openai/codex))\n\n## Usage\n\n```bash\ncd your-project\nclaudux          # Analyze code → generate docs (uses Claude by default)\nclaudux serve    # Preview at localhost:5173\n```\n\n## How It Works\n\nClaudux uses a two-phase flow:\n\n```mermaid\nflowchart LR\n    CODE[Your Codebase] --\u003e|analyze| PLAN[Phase 1: Plan]\n    PLAN --\u003e|outline + config| WRITE[Phase 2: Write]\n    WRITE --\u003e|generate pages| DOCS[VitePress Site]\n    DOCS --\u003e|validate links| CHECK{Links OK?}\n    CHECK --\u003e|yes| DONE[Done]\n    CHECK --\u003e|broken| WRITE\n```\n\n**Phase 1 — Plan:** Scans your source code, detects project type, reads any existing docs or config files (`CLAUDE.md`, `claudux.json`, `.ai-docs-style.md`), and builds a documentation outline with VitePress navigation.\n\n**Phase 2 — Write:** Generates markdown pages with correct cross-references, breadcrumbs, and code examples pulled from your actual codebase. Validates all internal links and auto-fixes broken ones.\n\nEverything runs locally — your code never leaves your machine.\n\n## Multi-Backend Support\n\nclaudux ships with a backend router that lets you choose which AI powers your documentation generation. Claude is the default; Codex is available as an alternative.\n\n| Backend | Env var | CLI required | Status |\n|---------|---------|-------------|--------|\n| Claude (default) | `CLAUDUX_BACKEND=claude` | `claude` ([install](https://docs.anthropic.com/claude/docs/claude-cli)) | Stable |\n| Codex | `CLAUDUX_BACKEND=codex` | `codex` ([install](https://github.com/openai/codex)) | Phase 1 complete |\n\n### Switch backends\n\n```bash\n# Default — uses Claude\nclaudux update\n\n# Use Codex instead\nCLAUDUX_BACKEND=codex claudux update\n\n# Or export for the session\nexport CLAUDUX_BACKEND=codex\nclaudux update\n```\n\n### Codex-specific settings\n\nWhen using the Codex backend, you can configure the model and reasoning effort:\n\n```bash\nexport CLAUDUX_BACKEND=codex\nexport CODEX_MODEL=gpt-5.4            # default: gpt-5.4\nexport CODEX_REASONING_EFFORT=xhigh   # default: xhigh\nclaudux update\n```\n\nThe Codex adapter runs in non-interactive exec mode with full sandbox access and streams JSONL progress events in real time.\n\n## Demo\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/terminal-demo.svg\" alt=\"claudux update terminal session\" width=\"100%\" /\u003e\n\u003c/p\u003e\n\n## Commands\n\n```bash\nclaudux                 # Interactive menu\nclaudux update          # Generate/update docs\nclaudux update -m \"...\" # Update with specific focus\nclaudux serve           # Start dev server\nclaudux diff            # Files changed since last doc gen\nclaudux status          # Documentation freshness\nclaudux validate        # Check internal links\nclaudux check           # Verify environment (Node, CLI, docs)\nclaudux template        # Generate claudux.md preferences\nclaudux recreate        # Delete docs and start over\nclaudux --version       # Show installed version\nclaudux --help          # Full options\n```\n\n## How Claudux Compares\n\n| | Claudux | TypeDoc / JSDoc | Docusaurus | Manual docs |\n|---|---|---|---|---|\n| **Input** | Your actual codebase | Type annotations only | Manually written MDX | Manually written |\n| **Output** | Full VitePress site | API reference only | Whatever you write | Whatever you write |\n| **Maintenance** | Re-run `claudux update` | Rebuild on change | Edit by hand | Edit by hand |\n| **AI-aware** | Yes — reads code structure and patterns | No | No | No |\n| **Link validation** | Built-in with auto-fix | No | Build-time only | No |\n\nClaudux doesn't replace API reference generators — it generates the docs you never write: guides, architecture overviews, getting started pages. Run it alongside TypeDoc, not instead of it.\n\n## Sibling Project\n\n**[vidux](https://github.com/leojkwan/vidux)** — plan-first orchestration for AI coding agents. If claudux is \"docs before code,\" vidux is \"plan before code.\" Same philosophy, different surface.\n\n## Configuration\n\nOptional `claudux.json` in project root:\n\n```json\n{\n  \"project\": {\n    \"name\": \"Your Project\",\n    \"type\": \"react\"\n  }\n}\n```\n\nAuto-detects project type from files (React, Next.js, Python, Go, iOS, Android, Rust, Rails, Flutter, etc.).\n\n## Architecture\n\nSee [ARCHITECTURE.md](./ARCHITECTURE.md) for the module map, two-phase generation pipeline, and backend router design.\n\n## Documentation\n\n**[Live docs](https://leojkwan.github.io/claudux/)** (generated by claudux itself)\n\n## License\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleojkwan%2Fclaudux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleojkwan%2Fclaudux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleojkwan%2Fclaudux/lists"}