I built Autodocs because understanding a new codebase shouldn't take hours

# cli# documentation# opensource# showdev
I built Autodocs because understanding a new codebase shouldn't take hoursDocify

Ever cloned a project and spent forever jumping between routes, models, services, and folders just...

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 .
Enter fullscreen mode Exit fullscreen mode

Generate documentation and understand the architecture, structure, and relationships inside your project.

Explain the project

npx @autodocify/autodocs explain .
Enter fullscreen mode Exit fullscreen mode

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
Enter fullscreen mode Exit fullscreen mode

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
Enter fullscreen mode Exit fullscreen mode

The idea

Your Code → Analyze → Understand → Document
Enter fullscreen mode Exit fullscreen mode

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.

🌐 Check out Docify

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!