DEV Community

Docify
Docify

Posted on

I Built a CLI That Helps You Understand Any Codebase

I built a CLI that turns your codebase into documentation

Ever opened an unfamiliar project and spent way too much time figuring out its structure, architecture, routes, models, and services?

I built Autodocs to make that easier.

It's an open-source CLI that analyzes your codebase and generates structured Markdown documentation based on the actual source code.

Analyze your project

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

This analyzes your project and generates documentation for its architecture and structure.

Or just explain it

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

This gives you a quick explanation of the codebase without having to dig through every file yourself.

Requires Node.js 20+.

Autodocs is part of Docify: https://docify.site/

It's still actively evolving, so I'd love to hear from developers who try it on real projects.

Try it, break it, and let me know what you'd want to see next.

Top comments (0)