Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mazshakibaii/reppy
Generate documentation for your entire codebase with just one command!
https://github.com/mazshakibaii/reppy
Last synced: 17 days ago
JSON representation
Generate documentation for your entire codebase with just one command!
- Host: GitHub
- URL: https://github.com/mazshakibaii/reppy
- Owner: mazshakibaii
- License: mit
- Created: 2024-11-05T21:47:30.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-11-06T01:39:27.000Z (about 1 month ago)
- Last Synced: 2024-11-06T02:25:36.666Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - mazshakibaii/reppy - Generate documentation for your entire codebase with just one command! (TypeScript)
README
# 🪄 reppy - let AI document your code
Use your favourite LLM to document for your entire codebase with just one command!
[](https://www.npmjs.com/package/reppy)
## ⭐️ Quick Start
1. Install with 1 command:
```bash
npm install -g reppy
```
2. **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:
```bash
export OPENAI_API_KEY=sk-1293527sd1824h
```
3. **Run the documentation generator:**
```zsh
reppy
```
Run `reppy -h` to see a list of available commands.
> N.B. You can also run `reppy` with `npx 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
- [x] Typescript & Javascript
- [x] Rust
- [x] Golang
- [x] Java
- [x] Python
### Models
- [x] OpenAI
- [x] Azure OpenAI
- [x] Amazon Bedrock
- [x] Anthropic
- [x] Cohere
- [x] Groq
## License
This project is licensed under the MIT License - see the LICENSE file for details.