1.2.8 • Published 9 months ago
reppy v1.2.8
🪄 reppy - let AI document your code
Use your favourite LLM to document for your entire codebase with just one command!
⭐️ Quick Start
- Install with 1 command:
npm install -g reppy
- Add your chosen LLM API key to your project's
.env
file (check.env.example
for options):
OPENAI_API_KEY=sk-1293527sd1824h
or, set it via your console:
export OPENAI_API_KEY=sk-1293527sd1824h
- Run the documentation generator:
reppy
Run reppy -h
to see a list of available commands.
N.B. You can also run
reppy
withnpx reppy
Features
- Git-awareness (ensures existing changes are committed before running)
- Auto-commit after documentation
- Saves your wallet by skipping functions that are already documented
- Concurrently process documentation tasks
- Create a
REPPY-README.md
file to document all the functions in your codebase
Coming soon
- Implement logic to allow for optional re-documentation of existing functions
Support
Langauges
- Typescript & Javascript
- Rust
- Golang
- Java
- Python
Models
- OpenAI
- Azure OpenAI
- Amazon Bedrock
- Anthropic
- Cohere
- Groq
License
This project is licensed under the MIT License - see the LICENSE file for details.
1.2.8
9 months ago
1.2.7
9 months ago
1.2.6
10 months ago
1.2.5
10 months ago
1.2.4
10 months ago
1.2.2
10 months ago
1.2.1
10 months ago
1.2.0
10 months ago
1.1.6
10 months ago
1.1.5
10 months ago
1.1.4
10 months ago
1.1.3
10 months ago
1.1.2
10 months ago
1.1.1
10 months ago
1.0.9
10 months ago
1.1.0
10 months ago
1.0.8
10 months ago
1.0.7
10 months ago
1.0.6
10 months ago
1.0.5
10 months ago
1.0.4
10 months ago
1.0.3
10 months ago
1.0.2
10 months ago
1.0.0
10 months ago