dearwolf/aider
1
0
Fork 0
mirror of https://github.com/Aider-AI/aider.git synced 2025-05-31 01:35:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
aider is AI pair programming in your terminal https://aider.chat/
241 commits 2 branches 243 tags 265 MiB
Find a file
Paul Gauthier eb1372236d Update README.md with installation and usage instructions for Aider tool. 
# Context:
USER: Use ORIGINAL/UPDATE format to provide a README.md for this tool
ASSISTANT: Here's a basic README.md for the Aider tool using the ORIGINAL/UPDATED format:

```
README.md
<<<<<<< ORIGINAL

=======
# Aider

Aider is a command-line tool that allows you to chat with GPT about your code. It helps you to make changes, improvements, and bug fixes to your code with the assistance of GPT.

## 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`.

## Usage

Run the Aider tool by executing the following command:

```
python -m aider.main <file1> <file2> ...
```

Replace `<file1>`, `<file2>`, etc., with the paths to the source code files you want to work on.

You can also use additional command-line options to customize the behavior of the tool. For more information, run:

```
python -m aider.main --help
```
>>>>>>> UPDATED
```

This will create a README.md file with a brief description, installation, and usage instructions for the Aider tool.
2023-05-09 11:40:27 -07:00
aider fixed import 2023-05-09 11:36:46 -07:00
.flake8 debug 2023-05-08 22:55:55 -07:00
.pre-commit-config.yaml added flake8 2023-05-07 22:13:57 -07:00
README.md Update README.md with installation and usage instructions for Aider tool. 2023-05-09 11:40:27 -07:00
requirements.txt initial 2023-05-09 10:55:05 -07:00
setup.py Add setup.py file that reads requirements.txt for dependencies and sets up CLI script. 2023-05-09 10:57:56 -07:00

README.md

Aider

Aider is a command-line tool that allows you to chat with GPT about your code. It helps you to make changes, improvements, and bug fixes to your code with the assistance of GPT.

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.

Usage

Run the Aider tool by executing the following command:

python -m aider.main <file1> <file2> ...

Replace <file1>, <file2>, etc., with the paths to the source code files you want to work on.

You can also use additional command-line options to customize the behavior of the tool. For more information, run:

python -m aider.main --help