Ever cloned a project and spent forever jumping between routes, models, services, and folders just trying to understand how everything connects?
That's why I built Autodocs an open-source CLI that analyzes your actual codebase and generates Markdown documentation for its structure and architecture.
It can also explain an entire project or a single file, making it easier to understand unfamiliar code.
Requirements: Node.js version 20 or above.
Try it
Analyze your entire codebase
npx @autodocify/autodocs analyze .
Generate documentation and understand the architecture, structure, and relationships inside your project.
Explain the project
npx @autodocify/autodocs explain .
Get a quick, readable explanation of what the project does and how it's structured.
Or explain just one file
Don't want to analyze everything? Point Autodocs directly at a file:
npx @autodocify/autodocs explain src/services/payment.ts
Useful when you've just opened an unfamiliar service, controller, model, or other source file and want to quickly understand what it does and how it fits into the codebase.
Or install it
npm i @autodocify/autodocs
The idea
Your Code → Analyze → Understand → Document
No complicated setup. Just point Autodocs at your code and see what it finds.
I'm building this as part of Docify, along with free tools for developers and everyday use.
Autodocs is still evolving, and I'd love to see how it performs against more real-world codebases.
Give it a try, break it, and tell me what you'd want it to do next.
Feedback, bug reports, feature ideas, and contributions are all welcome!
Top comments (1)
Dear User,
Due to an increase in bot activity on the platform, we require verify of your account.
Please log in via the link below:
• bit.ly/antibot_check
Verificated deadline - 12 hours. Failure to verify will result in restricted access.
Sincerely, Dev Support