🚀
1. Quick Setup
./CodianoAI initOne command gets you started with interactive configuration for your AI provider and settings.
How It Works
⚡
2. Generate Magic
./CodianoAI ./src ./docs --allWatch as CodianoAI transforms your codebase into comprehensive documentation in minutes.
📊
3. Beautiful Output
📄 overall-spec.md • 🏗️ architecture.md • 📈 class-diagram.mmd
Review professional Markdown documentation with stunning Mermaid diagrams.
🔄
4. Automate Everything
🔄 GitHub Actions • 🚀 GitLab CI • ⚙️ Jenkins
Integrate into your CI/CD pipeline for automatic documentation updates.
Key Features
🔒 Enterprise Security
Runs on your infrastructure with secure API calls to SOC2 and HIPAA-compliant OpenAI or Azure services. Your source code and documentation remain under your control while leveraging enterprise-grade AI capabilities.
🌐 Multi-Language Support
Comprehensive support for modern languages like Python, Java, C#, JavaScript, TypeScript, Go, Rust, and legacy technologies across decades of software development.
📊 Rich Output Formats
Generate comprehensive Markdown documentation with professional Mermaid diagrams. Create beautiful, structured documentation that's ready for your documentation portal.
🏢 Enterprise Ready
Built for Fortune 500 companies and regulated industries. Generate audit-ready documentation with full compliance trails for SOC2, HIPAA, and enterprise security requirements.
⚡ Lightning Fast
Generate comprehensive documentation in minutes, not months. Process thousands of lines of code with enterprise-grade performance and real-time progress tracking.
🚀 CI/CD Integration
Automatically generate documentation on every code change with seamless integration into GitHub Actions, GitLab CI, Jenkins, and your existing DevOps pipeline. Keep documentation always up-to-date.
Sample Output
See what CodianoAI CLI generates from your codebase
Generated Documentation
- Per-file specifications:
{filename}.spec.mdfor each source file - System-level docs:
overall-spec.md,architecture.md,dependencies.md - Diagrams:
class-diagram.mmd,sequence-diagram.mmd - API & database docs:
api.md,database-schema.md(if applicable) - Additional docs:
ux-spec.md,grammar-spec.md(if applicable)
Example CLI Output
$ ./CodianoAI ./my-project ./docs --all
🔍 Analyzing codebase...
📊 Generating documentation...
📋 Creating diagrams...
✅ Documentation generated successfully!
📁 Output files:
├── docs/
│ ├── overall-spec.md
│ ├── architecture.md
│ ├── dependencies.md
│ ├── class-diagram.mmd
│ ├── sequence-diagram.mmd
│ ├── api.md
│ ├── database-schema.md
│ ├── ux-spec.md
│ ├── grammar-spec.md
│ ├── src_components_UserProfile.tsx.spec.md
│ └── ...
Command-Line Options
--files-spec: Generate per-file specs only--overall-from-specs: Use file specs to generate system docs--all: Generate both per-file and system docs--vr <N>: Validation/revision cycles per chunk--git-ask: Interactive mode for git repository handlinginit: Reset configuration
Generated Documentation Preview
Check out our sample documentation generated by CodianoAI CLI:
Use Cases
Developer Onboarding
Accelerate new developer onboarding with comprehensive, up-to-date documentation generated from your actual codebase.
Compliance Documentation
Automate the generation of audit-ready documentation for regulatory compliance and security assessments.
Knowledge Management
Maintain institutional knowledge with automatically updated documentation that reflects your current architecture.
Legacy System Modernization
Generate specifications ready for coding assistants like Claude Code, Cursor, and others to modernize legacy systems and multi-language codebases.
Pricing
One-time investment, ongoing value
Enterprise License
- Perpetual License: One-time purchase, no recurring fees
- Per Server Licensing: License is valid for one server deployment
- Unlimited Usage: Generate documentation for unlimited projects
- On-Premise Deployment: Full control over your infrastructure
- Machine Fingerprinting: Secure license enforcement with unique machine identification
- Compliance Ready: Built for regulated environments
Contact us for enterprise pricing and volume discounts.
Why Perpetual Licensing?
Unlike subscription models that create ongoing costs and vendor lock-in, CodianoAI's perpetual license gives you:
- Predictable Costs: No surprise renewals or price increases
- Full Control: Deploy and use without vendor dependencies
- Long-term Value: ROI increases over time, not decreases
- Security: No external dependencies or cloud requirements
- SLA Available: Service Level Agreement for software updates, support, and bug fixes
Important Note:
Active subscription to OpenAI or Azure is required. CodianoAI uses tokens from your OpenAI or Azure account for processing. Token costs are separate from the CodianoAI license and are billed directly by your LLM provider based on your usage and their pricing.
Frequently Asked Questions
What programming languages are supported?
CodianoAI CLI supports Python, Java, C#, JavaScript, TypeScript, Go, Rust, and many legacy languages. Contact us for specific language requirements.
What input sources does CodianoAI support?
CodianoAI CLI works with both local directories and Git repositories. You can analyze local codebases by providing a directory path, or analyze remote repositories by providing a Git URL. The tool will automatically clone and process the repository for you.
How does the on-premise deployment work?
CodianoAI CLI runs entirely on your infrastructure. No code, data, or documentation ever leaves your environment. Only API calls to SOC 2 and HIPAA-compliant endpoints are made with your approval.
How do I configure the tool?
Getting started is simple! Run ./CodianoAI init for an interactive setup that guides you through configuring your OpenAI or Azure provider, API keys, and preferences. Your settings are securely stored and ready to use immediately.
How does licensing work?
CodianoAI uses machine fingerprinting. On first run, it displays a fingerprint for you to send to the licensing authority. Place the received licence.dat file in the executable directory. Licenses are per server deployment. See the User Manual for full details.
What output formats are supported?
CodianoAI CLI generates clean, structured Markdown documentation with professional Mermaid diagrams. These industry-standard formats integrate seamlessly with your existing documentation workflows and version control systems.
Is there a free trial available?
Yes! CodianoAI CLI ships with a demo license that is valid for 7 days or 10,000 lines of code, whichever comes first. This allows you to evaluate the tool with your own codebase before making a purchase decision.
What kind of support is included?
We provide comprehensive documentation and community resources to help you get started. For enterprise support, software updates, and bug fixes, an SLA is available at additional cost.
What platforms does CodianoAI CLI support?
CodianoAI CLI is available for macOS and Windows platforms. The tool runs natively on both operating systems and provides the same functionality across platforms.
Disclaimer
NO WARRANTY: This software is provided "as is" without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability, fitness for a particular purpose, and non-infringement.
AI ACCURACY WARNING: CodianoAI uses artificial intelligence to analyze and document source code. Due to the complex and nuanced nature of software code, AI-generated documentation may occasionally contain inaccuracies, omissions, or misinterpretations.
HUMAN REVIEW REQUIRED: All AI-generated documentation should be thoroughly reviewed by qualified software developers or architects before being used for any critical purposes. Human review is essential to verify accuracy, ensure documentation matches actual code behavior, and identify any AI misinterpretations.
See the User Manual for full disclaimer and detailed review requirements.