Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gauthierpiarrette/akita-ai
Your command-line, context-aware chatbot for instant codebase insights & more ✨
https://github.com/gauthierpiarrette/akita-ai
chainlit chatbot chatgpt cli copilot langchain llm openai openai-chatgpt python python-package
Last synced: about 1 month ago
JSON representation
Your command-line, context-aware chatbot for instant codebase insights & more ✨
- Host: GitHub
- URL: https://github.com/gauthierpiarrette/akita-ai
- Owner: gauthierpiarrette
- License: apache-2.0
- Created: 2024-02-26T18:03:52.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-30T13:09:41.000Z (9 months ago)
- Last Synced: 2024-05-08T00:18:48.756Z (8 months ago)
- Topics: chainlit, chatbot, chatgpt, cli, copilot, langchain, llm, openai, openai-chatgpt, python, python-package
- Language: Python
- Homepage: https://akita.ai
- Size: 474 KB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Akita AI
Your command-line, context-aware chatbot for instant codebase insights.
## 🌟 Key Features
- **✅ Personal Code Assistant**: Engage with Akita directly from your terminal for real-time codebase insights.
- **✅ Automated Documentation**: Instantly generate comprehensive documentation for your entire project.
- **✅ Tailored Code Reviews**: Receive AI-powered suggestions to improve your code quality.
- **✅ Quick Code Explainer**: Understand any piece of code with a simple command.
- **✅ Flexible Plugin System**: Customize Akita AI to fit perfectly into your development workflow.
## 🚀 Getting Started
### 1. Installation
Ensure you have Python 3.9+. Open a terminal and run:
```bash
$ pip install akita-ai
```
Set up your provider API key (currently integrates with [Gemini](https://gemini.google.com) and [ChatGPT](https://chat.openai.com)):
```bash
$ export GOOGLE_API_KEY=
```
Alternatively to use with ChatGPT
```bash
$ export OPENAI_API_KEY=
```
### 2. Engage with Your Personal Code Assistant
Start interacting with Akita Assistant for insights:
```bash
$ cd path/to/your/project
$ akita assistant
```
Ask Akita anything about your codebase for instant assistance.
## 🔗 Integrations
Connect Akita AI with your preferred providers for enhanced coding assistance.
*More integrations coming soon.*
## 🔍 Explore More Features
Dive into the additional features, designed to streamline your development workflow.
### File Selector
**Effortlessly select files** for Akita AI's analysis to focus enhancements where you need them.
- **Initiate with Akita**: Prepare your project.
```bash
$ akita init
```
- **Choose Files for Analysis**: Highlight specific files.
```bash
$ akita add
```
- **Exclude Files**: Easily remove files from the queue.
```bash
$ akita rm
```
### Instant Code Understanding
**Understand any piece of code with a simple command**, enhancing readability and maintainability.
```bash
$ akita describe
```
### Targeted Code Reviews
Receive **targeted, AI-driven feedback** on your code to identify improvements quickly.
```bash
$ akita review
```
### Quick README Creation
Generate **engaging READMEs** effortlessly, making your projects more accessible and understandable.
```bash
$ akita readme
```
See our detailed [commands documentation](https://github.com/gauthierpiarrette/akita-ai/blob/main/docs/Commands_Documentation.md) for more details.
## 💡 Contributing
Join our community of contributors! Whether you're fixing bugs, adding features, or improving documentation, your contributions make Akita AI better for everyone. See our [Contributors Guide](CONTRIBUTING.md) for how to get started.
## 📢 Feedback and Support
Your feedback shapes the future of Akita AI. Encounter a bug or have a feature suggestion? Open an issue on our [GitHub issues page](https://github.com/gauthierpiarrette/akita-ai/issues). For more support, contact us through our [homepage](https://akita.ai).
## 📜 License
Akita AI is open-source software licensed under the Apache 2.0 License. Feel free to use, modify, and distribute it as per the license.