dearwolf/aider
1
0
Fork 0
mirror of https://github.com/Aider-AI/aider.git synced 2025-05-28 08:14:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

updated readme

Browse source
This commit is contained in:
Paul Gauthier 2023-05-09 12:02:49 -07:00
parent f2dcfe3723
commit 68b9581188
1 changed files with 13 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -1,26 +1,26 @@
# Aider
Aider is a command-line tool that allows you to chat with GPT about your code.
It can make changes, improvements, and bug fixes to your code with the assistance of GPT.
Aider is a command-line tool that allows you to chat with GPT-4 about your code.
It can make changes, improvements, and bug fixes to your code.
Each change is automatically committed to git with a sensible commit message.
## Features
* Chat with GPT about your code by specifying a set of source files to discuss
* Request changes, improvements, and bug fixes to your code
* Chat with GPT about your code by specifying a set of source files to discuss.
* Request changes, improvements, and bug fixes to your code.
* Aider will apply the edits suggested by GPT.
* Aider will automatically commit each change to a git repo with a sensible commit message, providing safety, edit history and easy undo with normal git tools
* Live, colorized, human friendly output
* Can make coordinated changes across multiple source files
* Readline style chat input history, with autocompletion of tokens found in source files being discussed
* Use Control-C to safely interrupt GPT if it isn't providing a useful response
* Aider will notice if asked to discuss files with uncommitted changes and offer to commit them before proceeding
* Aider will automatically commit each change to a git repo with a sensible commit message, providing safety, edit history and easy undo with normal git tools.
* Aider can make coordinated code changes across multiple source files.
* Live, colorized, human friendly output.
* Readline style chat input history, with autocompletion of tokens found in source files being discussed (via `prompt_toolkit`)
* Use Control-C to safely interrupt GPT if it isn't providing a useful response.
* Provide a multiline chat message by entering `{` alone on a line. End the message with `}` alone on a line.
* Aider will notice if asked to discuss files with uncommitted changes and offer to commit them before proceeding.
## Installation
1. Clone the repository.
2. Install the required packages using `pip install -r requirements.txt`.
3. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including it in a `.env` file.
1. Install the package: `pip install git+https://github.com/paul-gauthier/aider.git`
2. Set up your OpenAI API key as an environment variable `OPENAI_API_KEY` or by including it in a `.env` file.
## Usage