dearwolf/aider
1
0
Fork 0
mirror of https://github.com/Aider-AI/aider.git synced 2025-06-15 00:54:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

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

Browse source 
# 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. 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).
=======
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, along with their corresponding environment variable overrides:

- `--history-file HISTORY_FILE`: Specify the history file (default: .aider.history). Override with the environment variable `AIDER_HISTORY_FILE`.
- `--model MODEL`: Specify the model to use for the main chat (default: gpt-4). No environment variable override.
- `-3`: Use gpt-3.5-turbo model for the main chat (basically won't work). No environment variable override.
- `--no-pretty`: Disable pretty, colorized output. Override with the environment variable `AIDER_PRETTY` (default: 1 for enabled, 0 for disabled).
- `--apply FILE`: Apply the changes from the given file instead of running the chat. No environment variable override.
- `--commit-dirty`: On launch, commit dirty files without confirmation (default: False). Override with the environment variable `AIDER_COMMIT_DIRTY` (default: 0 for False, 1 for True).
- `--show-diffs`: Show diffs when committing changes (default: False). Override with the environment variable `AIDER_SHOW_DIFFS` (default: 0 for False, 1 for True).
>>>>>>> UPDATED
```

This update provides a clearer explanation of the command-line arguments and their environment variable overrides.
This commit is contained in:
Paul Gauthier 2023-05-10 17:56:37 -07:00
parent 4c139ee0a2
commit 5e438941ce
1 changed files with 8 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

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