You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Big update with overhauls for langchain, anthropic and more. Breaking changes.
1. Support for openrouter removed
2. Support for Hugging Face removed
3. Anthropic support added
4. Update to the latest flavor of langchain with LECL
5. Chat Memory disabled for sidekick (to be put back in the future)
6. All config files moved to $HOME/.aicodebot/
7. Experimental features "sidekick-agent" and "learn" removed.
Copy file name to clipboardExpand all lines: README.md
+13-23
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,16 @@
2
2
3
3
## Your AI-powered coding sidekick
4
4
5
-
AICodeBot is a coding assistant designed to make your coding life easier. Think of it as your AI version of a pair programmer. Perform code reviews, create helpful commit messages, debug problems, and help you think through building new features. A team member that accelerates the pace of development and helps you write better code.
5
+
AICodeBot is a terminal-based coding assistant designed to make your coding life easier.
6
+
Think of it as your AI version of a pair programmer.
7
+
Perform code reviews, create helpful commit messages, debug problems, and help you think through building new features.
8
+
A team member that accelerates the pace of development and helps you write better code.
6
9
7
10
We've planned to build out multiple different interfaces for interacting with AICodeBot. To start, it's a [command-line tool](https://pypi.org/project/aicodebot/) that you can install and run in your terminal, and a [GitHub Action for Code Reviews](https://github.com/marketplace/actions/aicodebot-code-review).
8
11
9
-
Status: This project is in its early stages, but it already improves the software development workflow, and has a healthy roadmap of features (below).
12
+
Status: This project was built before AI Coding Assistants were cool. 🤓 As such, much of the functionality has
13
+
been replicated in various IDEs. Where AICodeBot shines is a) it's in the terminal, not GUI, and b) it can be used
14
+
in processes like GitHub actions.
10
15
11
16
We're using AICodeBot to build AICodeBot, and it's upward spiraling all the time.️ We're looking for contributors to help us build it out. See [CONTRIBUTING](https://github.com/TechNickAI/AICodeBot/blob/main/CONTRIBUTING.md) for more.
12
17
@@ -92,11 +97,12 @@ Commands:
92
97
sidekick Coding help from your AI sidekick
93
98
```
94
99
95
-
### Open AI key setup
100
+
### API Key setup
96
101
97
-
The first time you run it, you'll be prompted to enter your OpenAI API Key, which is required, as we use OpenAI's large language models for the AI. You can get one for free by visiting your [API key settings page](https://platform.openai.com/account/api-keys).
102
+
AICodeBot supports multiple Large Language Models, including Anthropic's Claude 3.x, and OpenAI's GPT-3/4x.
103
+
Pull requests for Gemini or Ollama are welcomed, but we feel these two do the trick.
98
104
99
-
Note: You will be billed by OpenAI based on how much you use it. Typical developers will use less than $10/month - which if you are a professional developer you'll likely more than make up for with saved time and higher quality work. See [OpenAI's pricing page](https://openai.com/pricing/) for more details. Also, see the note about increasing your token size and using better language models below.
105
+
The first time you run AICodeBot, you'll be prompted to enter your API keys
100
106
101
107
## Integration with GitHub Actions
102
108
@@ -161,30 +167,15 @@ It's also not a "build a site for me in 5 minutes" tool that takes a well-constr
161
167
162
168
## Configuring the language model to use
163
169
164
-
Not all OpenAI accounts have GPT-4 API access enabled. By default, AICodeBot will use GPT-4. If your OpenAI account supports it, we will check the first time you run it. If your OpenAI API does not support GPT-4, you can ask to be added to the waitlist [here](https://openai.com/waitlist/gpt-4-api). In our testing, GPT-4 is the best model and provides the best results.
165
-
166
170
To specify a different model, you can set the `language_model` in your `$HOME/.aicodebot.yaml` file. For example:
167
171
168
172
```yaml
169
173
openai_api_key: sk-*****
170
174
language_model: gpt-3.5-turbo
171
175
personality: Stewie
172
-
version: 1.2
173
-
```
174
-
175
-
You can also use openrouter.ai to get access to advanced models like GPT-4 32k and Anthropic's 100k model for larger context windows. See [openrouter.ai](https://openrouter.ai) for more details. Here's a sample config:
176
-
177
-
```yaml
178
-
openai_api_key: sk-*****
179
-
openrouter_api_key: sk-or-****
180
-
language_model_provider: OpenRouter
181
-
language_model: openai/gpt-4-32k # or anthropic/claude-2 for 100k token limit
182
-
personality: Stewie
183
-
version: 1.2
176
+
version: 1.3
184
177
```
185
178
186
-
Note: We'll be adding more options for AI models in the future, including those that can be run locally, such as [GPT4all](https://gpt4all.io/) and HuggingFace's [Transformers](https://huggingface.co/transformers/).
187
-
188
179
### Understanding Tokens and Using Commands Efficiently
189
180
190
181
In AI models like OpenAI's GPT-4, a "token" is a piece of text, as short as a character or as long as a word. The total tokens in an API call, including input and output, affect the cost, time, and whether the call works based on the maximum limit.
@@ -205,8 +196,7 @@ The context is too large (21414) for any of the models supported by your API key
205
196
There are a couple of things you can do:
206
197
207
198
1. Load fewer files into the context (only what you need to work with)
208
-
2. Apply for GPT-4-32k access from OpenAI by contacting them.
209
-
3. Use openrouter.ai - this allows you to use the full power of GPT-4-32k, which offers a 4x larger context window. See [openrouter.ai](https://openrouter.ai) for more details. Once you sign up and set your `openrouter_api_key` in your `$HOME/.aicodebot.yaml` file, you can have access to larger models. Soon we will have support for Claude 2, which has a 100k token limit.
199
+
2. Use Anthropic's Claude, which has much larger context window
0 commit comments