A powerful CLI tool for generating comprehensive markdown documentation for projects, using OpenAI's GPT.
Install aidocgen
using npm:
npm install -g aidocgen
Install aidocgen
using yarn:
yarn global add aidocgen
- Generates detailed documentation and tests for all code files and projects.
- Uses OpenAI's GPT-4 for intelligent and context-aware documentation.
- Easy to set up and use with a simple CLI interface.
Before using aidocgen, you need to set your OpenAI API key. Run the initialization command and follow the prompts:
aidocgen init
You will be asked to provide your OpenAI API key which will be set locally for your future use. We do not have access to your OpenAI API key.
aidocgen parse path/to/yourFile.ts
aidocgen parse path/to/yourDirectory
### Generate test for a single file:
```bash
aidocgen test-file "file path" "test framework, e.g jest | mocha"
aidocgen test-directory "file path" "test framework, e.g jest | mocha"
Contributions are welcome! If you have an idea for improvement or have found a bug, please open an issue or submit a pull request.
https://github.com/shammahk/aidocgen
aidocgen
is MIT licensed.