From 5e438941ce0ae0fdc15ec8b275ab3951d9ae3f25 Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Wed, 10 May 2023 17:56:37 -0700 Subject: [PATCH] aider: Updated the 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. 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 ... ``` 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, 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. --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index b17dcab45..b7557798e 100644 --- a/README.md +++ b/README.md @@ -36,16 +36,15 @@ 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). +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