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
{{ message }}
This repository was archived by the owner on Mar 9, 2026. It is now read-only.
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. 📚🔮
Copy file name to clipboardExpand all lines: README.md
+5-9Lines changed: 5 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff 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
32
32
33
33
`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.
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).
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").
69
63
70
-
#### GPT-3.5 vs GPT-4
64
+
#### Which Language Model? GPT-3.5 vs GPT-4
71
65
72
66
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.
73
67
74
68
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)
75
69
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/).
0 commit comments