doc-comments-ai 0.1.8

No project description provided

Generate your code documentation with doc-comments.ai

Focus on writing your code, let AI write the documentation for you. With just a few keystrokes in your terminal.

✨ Features

• 📝 Create documentation comment blocks for all methods in a file
  • e.g. Javadoc, JSDoc, Docstring, Rustdoc
• ✍️ Create inline documentation comments in method bodies
• 🌳 Treesitter integration

[!NOTE] Documentations will only be added to files without unstaged changes, so that nothing is overwritten.

🚀 Usage

• aicomments <RELATIVE_FILE_PATH>: Create documentations for any method in the file which doesn't have any yet.
• aicomments <RELATIVE_FILE_PATH> --inline: Create also documentation comments in the method body.
• aicomments <RELATIVE_FILE_PATH> --gpt4: Use GPT-4 model (Default is GPT-3.5).
• aicomments <RELATIVE_FILE_PATH> --guided: Guided mode, confirm documentation generation for each method.

⚙️ Supported Languages

• Python
• Typescript
• Javascript
• Java
• Rust
• Kotlin
• Go
• C++
• C
• Scala

📋 Requirements

• Python >= 3.9

🔧 Installation

Create your personal OpenAI Api key and add it as $OPENAI_API_KEY to your environment with:

export OPENAI_API_KEY=<YOUR_API_KEY>

Install with pipx:

pipx install doc-comments-ai

[!NOTE] It is recommended to use pipx for installation, nonetheless it is also possible to use pip.

🚨 Disclaimer

Your code won't be stored, but your code does leave your machine.