Generate, translate, and publish production-ready documentation straight from your codebase—kept in sync with every release.
1npm install -g @aigne/cli
2aigne doc
Docs update automatically from code and comments.
Create API, SDK, and guides in minutes.
Works across JS/TS, Python, Go, Java, and more.
Run on every PR or release; review changes before publish.
From setup to live docs—simple, fast, and fully automated
Init & Generate
1aigne doc generate
Shell
_ ___ ____ _ _ _____
/ \ |_ _/ ___| \ | | ____|
/ _ \ | | | _| \| | _|
/ ___ \ | | |_| | |\ | |___
/_/ \_\___\____|_| \_|_____|
🚀 Welcome to AIGNE DocSmith!
Let's create your documentation configuration.
✔ 📝 Step 1/6: Choose your documentation style: Developer Docs - Steps-first; copy-paste examples; minimal context; active 'you'.
✔ 👥 Step 2/6: Who is your target audience? Developers, Implementation Engineers, DevOps
✔ 🌐 Step 3/6: Choose primary documentation language: English (en) - Hello
✔ 🔄 Step 4/6: Select translation languages: 简体中文 (zh) - 你好
✔ 📁 Step 5/6: Where to save generated docs: .aigne/doc-smith/docs
🔍 Step 6/6: Source Code Paths
Enter paths to analyze for documentation (e.g., ./src, ./lib)
💡 If no paths are configured, './' will be used as default
✔ Path: Press Enter to finish
🎉 Configuration saved to: .aigne/doc-smith/config.yaml
💡 You can edit the configuration file anytime to modify settings.
🚀 Run 'aigne doc generate' to start documentation generation!
Publish
1aigne doc publish
Shell
_ ___ ____ _ _ _____
/ \ |_ _/ ___| \ | | ____|
/ _ \ | | | _| \| | _|
/ ___ \ | | |_| | |\ | |___
/_/ \_\___\____|_| \_|_____|
✔ Select platform to publish your documents: Publish to docsmith.aigne.io - free, but your documents will be public accessible,
recommended for open-source projects
📋 Project Information for Documentation Platform
📖 Docs available at: https://docsmith.aigne.io/app/
Experience a faster, smarter way to create and maintain documentation. Try DocSmith today and see how effortless great docs can be