andiku
v1.0.4
Published
AI-powered documentation generator that creates comprehensive, essay-style documentation for your codebase.
Readme
Andiku CLI
AI-powered documentation generator that creates comprehensive, essay-style documentation for your codebase.
Installation
npm install -g andikuUsage
Generate Documentation
Navigate to your project directory and run:
andikuThe CLI will:
- Scan your project structure
- Let you select files to document
- Generate comprehensive documentation using AI
- Save the documentation to a
docs/folder
Authentication
First time users need to authenticate:
andiku auth loginInteractive Mode
The CLI provides an interactive interface to:
- Select specific files or directories
- Choose documentation templates
- Configure output settings
- Preview cost estimates
Features
- 🤖 AI-Powered: Uses Claude 3.5 Sonnet for high-quality documentation
- 📂 Smart File Selection: Automatically detects code files and lets you choose what to document
- 💰 Cost Estimation: Shows token costs before generation
- 🎯 Multiple Templates: Choose from basic, API, or custom documentation styles
- 📊 Progress Tracking: Real-time feedback during generation
- 🔒 Secure: Encrypted content storage and secure authentication
Documentation Templates
Basic Template
General purpose documentation for any code file.
API Template
Specialized for REST APIs, includes endpoint documentation, request/response examples, and authentication details.
Configuration
Create a .andiku.yml file in your project root to customize settings:
# Andiku CLI Configuration
include:
- "src/**/*.ts"
- "src/**/*.js"
- "lib/**/*.py"
exclude:
- "node_modules/**"
- "dist/**"
- "*.test.*"
- "*.spec.*"
output:
directory: "docs"
format: "markdown"
templates:
default: "basic"
api_files: "api"Commands
andiku- Start interactive documentation generationandiku auth login- Authenticate with your accountandiku auth logout- Sign outandiku --help- Show help information
Support
For issues and support, visit: GitHub Issues
License
ISC License
