From 1b7b0fddfe1c71e606705f26a127df8059373fe0 Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Wed, 10 May 2023 17:52:12 -0700 Subject: [PATCH] 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 ... ``` Replace ``, ``, 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 ... ``` Replace ``, ``, 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 ``` --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cbc7e1b42..b17dcab45 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,17 @@ aider ... Replace ``, ``, 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