# DocGen CLI
An AI-powered documentation generator that automatically creates comprehensive documentation for any programming language.
## Features
- 🤖 AI-powered documentation generation
- 🌐 Language-agnostic code analysis
- 📝 Markdown and docstring generation
- 🔄 Git integration for tracking code changes
- ⚡ Asynchronous batch processing
- 💾 Smart caching system
- 🔑 API key management
- 📊 Usage tracking
## Installation
bash
pip install docgen-cli
## Quick Start
1. Get your API key from our website
2. Login with your API key:
```bash
docgen auth login --key YOUR_API_KEY
```
3. Generate documentation for a file or directory:
```bash
docgen generate -f path/to/file.py
# or
docgen generate --current-dir
```
4. Update documentation for changed files:
```bash
docgen update
```
## Usage
### Basic Commands
- `docgen generate`: Generate documentation for files or directories
- `docgen update`: Update docs for changed files (Git-aware)
- `docgen analyze`: Analyze code structure and complexity
- `docgen auth`: Manage API authentication
- `docgen config`: Configure settings
- `docgen clean`: Remove generated documentation
### Examples
```bash
# Generate docs for current directory
docgen generate --current-dir
# Generate docs for a specific file
docgen g -f src/main.py
# Update documentation for changed files
docgen update
# Configure output format
docgen config output_format html
```
## Configuration
Create a `.docgen.json` file in your project root:
```json
{
"output_format": "markdown",
"output_dir": "docs",
"exclude_patterns": ["**/test/*", "**/*.test.*"],
"language_settings": {
"python": {
"docstring_style": "google"
}
}
}
```
## Supported Languages
- Python
- JavaScript/TypeScript
- Java
- And more...
## Contributing
Contributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) for details.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/aniket-0-cyber/docgen-cli",
"name": "docgen-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "documentation generator ai development tools docstring markdown",
"author": "Aniket Singh",
"author_email": "aniket0999@gmail.com",
"download_url": null,
"platform": null,
"description": "# DocGen CLI\n\nAn AI-powered documentation generator that automatically creates comprehensive documentation for any programming language.\n\n## Features\n\n- \ud83e\udd16 AI-powered documentation generation\n- \ud83c\udf10 Language-agnostic code analysis\n- \ud83d\udcdd Markdown and docstring generation\n- \ud83d\udd04 Git integration for tracking code changes\n- \u26a1 Asynchronous batch processing\n- \ud83d\udcbe Smart caching system\n- \ud83d\udd11 API key management\n- \ud83d\udcca Usage tracking\n\n## Installation\nbash\npip install docgen-cli\n\n## Quick Start\n\n1. Get your API key from our website\n2. Login with your API key:\n\n```bash\ndocgen auth login --key YOUR_API_KEY\n```\n\n3. Generate documentation for a file or directory:\n\n```bash\ndocgen generate -f path/to/file.py\n# or\ndocgen generate --current-dir\n```\n\n4. Update documentation for changed files:\n\n```bash\ndocgen update\n```\n\n## Usage\n\n### Basic Commands\n\n- `docgen generate`: Generate documentation for files or directories\n- `docgen update`: Update docs for changed files (Git-aware)\n- `docgen analyze`: Analyze code structure and complexity\n- `docgen auth`: Manage API authentication\n- `docgen config`: Configure settings\n- `docgen clean`: Remove generated documentation\n\n### Examples\n\n```bash\n# Generate docs for current directory\ndocgen generate --current-dir\n\n# Generate docs for a specific file\ndocgen g -f src/main.py\n\n# Update documentation for changed files\ndocgen update\n\n# Configure output format\ndocgen config output_format html\n```\n\n## Configuration\n\nCreate a `.docgen.json` file in your project root:\n\n```json\n{\n \"output_format\": \"markdown\",\n \"output_dir\": \"docs\",\n \"exclude_patterns\": [\"**/test/*\", \"**/*.test.*\"],\n \"language_settings\": {\n \"python\": {\n \"docstring_style\": \"google\"\n }\n }\n}\n```\n\n## Supported Languages\n\n- Python\n- JavaScript/TypeScript\n- Java\n- And more...\n\n## Contributing\n\nContributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) for details.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "AI-Powered Documentation Generator for Developers",
"version": "1.0.4",
"project_urls": {
"Bug Reports": "https://github.com/aniket-0-cyber/docgen-cli/issues",
"Homepage": "https://github.com/aniket-0-cyber/docgen-cli",
"Source": "https://github.com/aniket-0-cyber/docgen-cli"
},
"split_keywords": [
"documentation",
"generator",
"ai",
"development",
"tools",
"docstring",
"markdown"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ffbb2922269ff5ebe4f83b61f78167b0a19253317a6f066fe914939040c90df3",
"md5": "c331efdaf813f8835622484654a45278",
"sha256": "f9f3d3cc2ccbdfd2ed928dd79b9bab28dc6413c67c0dd5b00838660c89eb23c0"
},
"downloads": -1,
"filename": "docgen_cli-1.0.4-cp39-cp39-macosx_10_9_universal2.whl",
"has_sig": false,
"md5_digest": "c331efdaf813f8835622484654a45278",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7",
"size": 164663,
"upload_time": "2025-02-09T18:11:21",
"upload_time_iso_8601": "2025-02-09T18:11:21.769975Z",
"url": "https://files.pythonhosted.org/packages/ff/bb/2922269ff5ebe4f83b61f78167b0a19253317a6f066fe914939040c90df3/docgen_cli-1.0.4-cp39-cp39-macosx_10_9_universal2.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-09 18:11:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aniket-0-cyber",
"github_project": "docgen-cli",
"github_not_found": true,
"lcname": "docgen-cli"
}
JSON
