docit-ai
v1.0.2
Published
AI-powered documentation generator
Readme
docit-ai
Docit is a CLI-first, npm-distributed tool that generates and automatically updates technical documentation for software projects. It is designed to be a high-performance, affordable alternative to Mintlify. It utilizes local parsing (AST) combined with cost-effective LLMs (Gemini 2.5 Flash-Lite) to keep token costs minimal.
Features
Persona-Based Views
Docit formats the AI output into three distinct sections within the generated documentation:
- Strategic View (For Project Managers): Focuses on business value and status. Includes high-level summaries and a "Completeness Score".
- Technical View (For Developers): Focuses on architecture and integration. Includes function signatures, dependency maps, and "How to use" code examples.
- Personal View (For Individuals): Focuses on productivity and reminders. Includes a "To-Do" list generated from TODO comments and a "Technical Debt" summary.
Core Architecture
- Scanner: Uses simple-git to identify files modified in the last commit.
- Parser: Uses tree-sitter to extract "Code Skeletons" (function names, parameters, return types, and comments) to reduce token usage.
- Engine: Orchestrates calls to the LLM (Default: Gemini 2.5 Flash-Lite).
- Formatter: Generates three distinct views of the documentation.
Installation
npm install -g docit-aiUsage
The main command to generate documentation is sync.
docit-ai sync