Skip to content
This repository was archived by the owner on Mar 9, 2026. It is now read-only.

Commit 7e0cf1a

Browse files
committed
Update README and code_agent docs, remove WIP feature
This commit updates the README.md and code_agent.md files. The changes include: - Removal of the "AI-Assisted Code Creation" section from README.md as it was a work-in-progress feature. - Addition of a PyPI version badge in README.md. - Reorganization of the "Installation and Usage" section in README.md. - Clarification on the choice between GPT-3.5 and GPT-4 in README.md. - Mention of future support for local AI models in README.md. - In code_agent.md, the 'code' command is now presented as a future vision, not a current feature. - Additional context provided for the 'code' command in code_agent.md. These changes aim to provide clearer and more accurate information about the current state and future plans of the project. 📚🔮
1 parent 08e47b4 commit 7e0cf1a

File tree

2 files changed

+13
-11
lines changed

2 files changed

+13
-11
lines changed

README.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,9 @@ It's also not a "build a site for me in 5 minutes" tool that takes a well constr
3232

3333
`aicodebot debug $command` will run the command and capture the log message. It will pass the error message, stack trace, comand output, etc. to the AI and respond with some suggestions on how to fix it. It saves a trip to stackoverflow in a separate window, allowing you to stay in terminal with all the context.
3434

35-
### AI-Assisted Code Creation (Work in Progress)
35+
[![PyPI version](https://badge.fury.io/py/aicodebot.svg?0.6.2)](https://badge.fury.io/py/aicodebot)
3636

37-
The aicodebot code feature is an AI-powered tool that automates coding tasks. It understands your task, formulates a plan, learns necessary information, and generates code that fits your codebase style. It also reviews its own work, modifies the local code, and creates unit tests. This feature is designed to streamline your coding process and boost productivity. In the future, we plan to enhance its performance through a continuous learning system based on user feedback and interaction outcomes.
38-
39-
This feature is a work in progress, and it's more thoroughly documented [here](docs/code_agent.md) and we're excited about its potential to boost developer productivity. If you'd like to help, see [CONTRIBUTING](CONTRIBUTING.md).
40-
41-
## Getting Started
42-
43-
[![PyPI version](https://badge.fury.io/py/aicodebot.svg)](https://badge.fury.io/py/aicodebot)
37+
## Installation and Usage
4438

4539
To install AICodeBot, run:
4640

@@ -67,12 +61,14 @@ Commands:
6761

6862
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").
6963

70-
#### GPT-3.5 vs GPT-4
64+
#### Which Language Model? GPT-3.5 vs GPT-4
7165

7266
When using AICodeBot, you have the option to use either GPT-3.5 or GPT-4. While GPT-4 can often provide more accurate and detailed responses, GPT-3.5 is faster and might be sufficient for simpler tasks. We highly recommend GPT-4.
7367

7468
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. Tip: 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)
7569

70+
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/).
71+
7672
## Roadmap of Upcoming Features
7773

7874
### Code Workflow Improvements

docs/code_agent.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
# AICodeBot Code Agent
22

3-
The 'code' command is a new feature of AICodeBot designed to automate coding
3+
Note: The `code` feature does not exist, yet. It is a vision for the future,
4+
ala [README driven development](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
5+
6+
The 'code' command for AICodeBot is designed to automate coding
47
tasks based on instructions from you. This feature aims to boost developer
58
productivity by handling various aspects of the coding process, but keeping you
6-
in charge of the process.
9+
in charge of the process and commiting the code.
10+
11+
It's not intended to build entire applications, but instead improve existing
12+
code bases one git commit at a time.
713

814
## Feature Overview
915

0 commit comments

Comments
 (0)