aider: Updated Usage section in README.md to explain all the command line arguments and their environment variable overrides.

# Context:
USER: update the Usage section to explain all the command line args and their env overrides
ASSISTANT: I will update the Usage section in the README.md file to explain all the command line arguments and their environment variable overrides.

```python
README.md
<<<<<<< ORIGINAL
Run the Aider tool by executing the following command:

```
aider <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 `aider --help`. Many defaults can be set with `.env` or environment variables, see the help output.
=======
Run the Aider tool by executing the following command:

```
aider <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. The following options are available:

- `--history-file HISTORY_FILE`: Specify the history file (default: .aider.history, AIDER_HISTORY_FILE).
- `--model MODEL`: Specify the model to use for the main chat (default: gpt-4).
- `-3`: Use gpt-3.5-turbo model for the main chat (basically won't work).
- `--no-pretty`: Disable pretty, colorized output (AIDER_PRETTY).
- `--apply FILE`: Apply the changes from the given file instead of running the chat.
- `--commit-dirty`: On launch, commit dirty files w/o confirmation (default: False, AIDER_COMMIT_DIRTY).
- `--show-diffs`: Show diffs when committing changes (default: False, AIDER_SHOW_DIFFS).

For more information, run `aider --help`. Many defaults can be set with `.env` or environment variables, see the help output.
>>>>>>> UPDATED
```
This commit is contained in:
Paul Gauthier 2023-05-10 17:52:12 -07:00
parent 42ccd9c550
commit 1b7b0fddfe

View file

@ -36,7 +36,17 @@ aider <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 `aider --help`. Many defaults can be set with `.env` or environment variables, see the help output.
You can also use additional command-line options to customize the behavior of the tool. The following options are available:
- `--history-file HISTORY_FILE`: Specify the history file (default: .aider.history, AIDER_HISTORY_FILE).
- `--model MODEL`: Specify the model to use for the main chat (default: gpt-4).
- `-3`: Use gpt-3.5-turbo model for the main chat (basically won't work).
- `--no-pretty`: Disable pretty, colorized output (AIDER_PRETTY).
- `--apply FILE`: Apply the changes from the given file instead of running the chat.
- `--commit-dirty`: On launch, commit dirty files w/o confirmation (default: False, AIDER_COMMIT_DIRTY).
- `--show-diffs`: Show diffs when committing changes (default: False, AIDER_SHOW_DIFFS).
For more information, run `aider --help`. Many defaults can be set with `.env` or environment variables, see the help output.
## Commands