Code2Docs: An AI-powered, open source CLI tool for generating inline code documentation, API references, database schema docs, and project READMEs from your codebase.
Project description
🚀 Code2Docs CLI
Code2Docs is an AI-powered CLI tool that helps you generate high-quality documentation for your codebase — including inline docstrings, API documentation, database schema descriptions, and project READMEs.
⚠️ This project is still under active development. Expect new features and improvements regularly.
📚 Base Repo: https://github.com/xKarinSan/Code2Docs
💬 Community Discord: https://discord.gg/qugCeYBYud
🌐 Landing Page: https://code2docs-open-source.netlify.app/
🔗 LinkedIn: https://www.linkedin.com/company/code2docs
✨ Features
- 📄 Inline documentation (docstrings + inline comments) beta
- 📡 API endpoint documentation (coming soon)
- 🧩 Database schema documentation (coming soon)
- 📘 README.md generation (coming soon)
- 🗂️ Architecture diagram generation beta
🔐 Requirements
- Python 3.8 or newer
- An OpenAI API key
- A Git-initialized codebase
🧪 Installation
-
Install the CLI:
pip install code2docs-cli -
Run the CLI to verify the installation:
c2d
🚀 Getting Started
To begin using Code2Docs:
- Make sure your project is inside a Git repository.
- Get your OpenAI API key from platform.openai.com.
- Save your API key locally using:
c2d save-key sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
- You’re ready to generate documentation!
🛠️ CLI Commands
--help
Lists ALL the commands for Code2Docs CLI
code-doc(Beta)
Generates inline documentation (docstrings and comments) for your codebase.
c2d code-doc
api-doc (Coming Soon)
Generates documentation for your API endpoints.
c2d api-doc
db-doc (Coming Soon)
Generates documentation for your database schema.
c2d db-doc
readme-doc (Beta)
Generates a project-level README.md based on your codebase.
c2d readme-doc
archi-doc (Beta)
Generates an architecture diagram based on the structure of your codebase.
c2d archi-doc
save-key
Saves your OpenAI API key locally for authentication.
c2d save-key sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
load-key
Displays the currently saved OpenAI API key.
c2d load-key
--help
Displays all available commands and usage.
c2d --help
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file code2docs_cli-1.3.0.tar.gz.
File metadata
- Download URL: code2docs_cli-1.3.0.tar.gz
- Upload date:
- Size: 10.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.9 Darwin/21.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
81691aefb2191fbb64a1f46e0d80db7118aaa3176aa367ec2b5fb5c034776249
|
|
| MD5 |
c1e240c992a5de61187249c7de8de358
|
|
| BLAKE2b-256 |
136aa26462d5371e45706b6b026fb48ef3ba2a7df8ff87a4a5aa01a865c57ec6
|
File details
Details for the file code2docs_cli-1.3.0-py3-none-any.whl.
File metadata
- Download URL: code2docs_cli-1.3.0-py3-none-any.whl
- Upload date:
- Size: 12.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.2 CPython/3.12.9 Darwin/21.6.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e77cd3363e184b77982bd2bda1dcc53ab1a8ef2eaa8a130d8baab36ebbed23d8
|
|
| MD5 |
72e05e858a436d2275dcbd2d3d62ac36
|
|
| BLAKE2b-256 |
4c7fc9d6f611ee03e819dcaf832b09b122eb50425c70cf1e7babd1e422504d78
|
