From 0e5342fdb8d3ee3f0e380ca8f8c595b74ce17bb2 Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Thu, 6 Jun 2024 11:01:27 -0700 Subject: [PATCH] copy --- aider/gui.py | 4 +- aider/models.py | 2 +- aider/scrape.py | 2 +- scripts/update-docs.sh | 4 +- website/docs/{llms => }/dotenv.md | 6 +- website/docs/install.md | 9 +- website/docs/options.md | 169 +---------------------------- website/docs/options_ref.md | 170 ++++++++++++++++++++++++++++++ 8 files changed, 189 insertions(+), 177 deletions(-) rename website/docs/{llms => }/dotenv.md (79%) create mode 100644 website/docs/options_ref.md diff --git a/aider/gui.py b/aider/gui.py index acf99532c..e064aaf70 100755 --- a/aider/gui.py +++ b/aider/gui.py @@ -163,7 +163,7 @@ class GUI: with st.popover("Create a git repo to track changes"): st.write( "Aider works best when your code is stored in a git repo. \n[See the FAQ" - " for more info](https://aider.chat/docs/faq.html#how-does-aider-use-git)" + " for more info](https://aider.chat/docs/git.html)" ) self.button("Create git repo", key=random.random(), help="?") @@ -515,7 +515,7 @@ def gui_main(): page_title="Aider", page_icon="https://aider.chat/assets/favicon-32x32.png", menu_items={ - "Get Help": "https://aider.chat/docs/faq.html", + "Get Help": "https://aider.chat/", "Report a bug": "https://github.com/paul-gauthier/aider/issues", "About": "# Aider\nAI pair programming in your browser.", }, diff --git a/aider/models.py b/aider/models.py index c32840d82..60a18a23d 100644 --- a/aider/models.py +++ b/aider/models.py @@ -471,7 +471,7 @@ def sanity_check_model(io, model): io.tool_error(f"- {m} ({fq})") if show: - io.tool_error("For more info see https://aider.chat/docs/llms.html#model-warnings") + io.tool_error("For more info see https://aider.chat/docs/llms/warnings.html") def fuzzy_match_models(name): diff --git a/aider/scrape.py b/aider/scrape.py index 650075905..ea0734f62 100755 --- a/aider/scrape.py +++ b/aider/scrape.py @@ -19,7 +19,7 @@ For better web scraping, install Playwright chromium with this command in your t playwright install --with-deps chromium -See https://aider.chat/docs/install.html#enable-playwright-optional for more info. +See https://aider.chat/docs/install/optional.html#enable-playwright for more info. """ diff --git a/scripts/update-docs.sh b/scripts/update-docs.sh index 3148a02c2..c64f9cf84 100755 --- a/scripts/update-docs.sh +++ b/scripts/update-docs.sh @@ -11,6 +11,6 @@ fi cog $ARG \ website/index.md \ - website/docs/usage.md \ website/docs/commands.md \ - website/docs/languages.md + website/docs/languages.md \ + website/docs/options_ref.md diff --git a/website/docs/llms/dotenv.md b/website/docs/dotenv.md similarity index 79% rename from website/docs/llms/dotenv.md rename to website/docs/dotenv.md index 33af0020c..f867fd0e1 100644 --- a/website/docs/llms/dotenv.md +++ b/website/docs/dotenv.md @@ -1,12 +1,14 @@ --- -parent: Connecting to LLMs +parent: Configuration nav_order: 900 --- -# Using a .env file +# Storing LLM params in .env You can use a `.env` file to store various keys and other settings for the models you use with aider. +You currently can not set general aider options +in the `.env` file, only LLM environment variables. Aider will look for a `.env` file in the root of your git repo or in the current directory. diff --git a/website/docs/install.md b/website/docs/install.md index 0f0195b6f..1cba434e0 100644 --- a/website/docs/install.md +++ b/website/docs/install.md @@ -20,8 +20,11 @@ $ export ANTHROPIC_API_KEY=your-key-goes-here $ aider --opus ``` -Or see the full -[installation instructions](/docs/install/install.html) -for more details. +Or see +[full installation instructions](/docs/install/install.html) +for more details, +or the +[usage instructions](https://aider.chat/docs/usage.html) to start coding with aider. + diff --git a/website/docs/options.md b/website/docs/options.md index 1c1f8187d..31e3c6850 100644 --- a/website/docs/options.md +++ b/website/docs/options.md @@ -1,8 +1,9 @@ --- nav_order: 55 +has_children: true --- -# Configuration & options +# Configuration Aider has many options which can be set with command line switches. @@ -10,7 +11,7 @@ Most options can also be set in an `.aider.conf.yml` file which can be placed in your home directory or at the root of your git repo. Or via environment variables like `AIDER_xxx`, -as noted in the help text below. +as noted in the [options reference](options_ref.html). Here are 3 equivalent ways of setting an option. First, via a command line switch: @@ -30,167 +31,3 @@ Or in the `.aider.conf.yml` file: dark-mode: true ``` -## Command line reference - -Use `aider --help` to see all the available options. - - -``` -usage: aider [-h] [--openai-api-key OPENAI_API_KEY] [--anthropic-api-key ANTHROPIC_API_KEY] - [--model MODEL] [--opus] [--sonnet] [--4] [--4o] [--4-turbo] [--35turbo] - [--models MODEL] [--openai-api-base OPENAI_API_BASE] - [--openai-api-type OPENAI_API_TYPE] [--openai-api-version OPENAI_API_VERSION] - [--openai-api-deployment-id OPENAI_API_DEPLOYMENT_ID] - [--openai-organization-id OPENAI_ORGANIZATION_ID] [--edit-format EDIT_FORMAT] - [--weak-model WEAK_MODEL] [--show-model-warnings | --no-show-model-warnings] - [--map-tokens MAP_TOKENS] [--max-chat-history-tokens MAX_CHAT_HISTORY_TOKENS] - [--env-file ENV_FILE] [--input-history-file INPUT_HISTORY_FILE] - [--chat-history-file CHAT_HISTORY_FILE] - [--restore-chat-history | --no-restore-chat-history] [--dark-mode] [--light-mode] - [--pretty | --no-pretty] [--stream | --no-stream] - [--user-input-color USER_INPUT_COLOR] [--tool-output-color TOOL_OUTPUT_COLOR] - [--tool-error-color TOOL_ERROR_COLOR] - [--assistant-output-color ASSISTANT_OUTPUT_COLOR] [--code-theme CODE_THEME] - [--show-diffs] [--git | --no-git] [--gitignore | --no-gitignore] - [--aiderignore AIDERIGNORE] [--auto-commits | --no-auto-commits] - [--dirty-commits | --no-dirty-commits] [--dry-run | --no-dry-run] [--commit] [--lint] - [--lint-cmd LINT_CMD] [--auto-lint | --no-auto-lint] [--test-cmd TEST_CMD] - [--auto-test | --no-auto-test] [--test] [--voice-language VOICE_LANGUAGE] [--version] - [--check-update] [--skip-check-update] [--apply FILE] [--yes] [-v] [--show-repo-map] - [--show-prompts] [--message COMMAND] [--message-file MESSAGE_FILE] - [--encoding ENCODING] [-c CONFIG_FILE] [--gui] - [FILE ...] - -aider is GPT powered coding in your terminal - -options: - -h, --help show this help message and exit - -Main: - FILE files to edit with an LLM (optional) - --openai-api-key OPENAI_API_KEY - Specify the OpenAI API key [env var: OPENAI_API_KEY] - --anthropic-api-key ANTHROPIC_API_KEY - Specify the OpenAI API key [env var: ANTHROPIC_API_KEY] - --model MODEL Specify the model to use for the main chat (default: gpt-4o) - --opus Use claude-3-opus-20240229 model for the main chat - --sonnet Use claude-3-sonnet-20240229 model for the main chat - --4, -4 Use gpt-4-0613 model for the main chat - --4o Use gpt-4o model for the main chat - --4-turbo Use gpt-4-1106-preview model for the main chat - --35turbo, --35-turbo, --3, -3 - Use gpt-3.5-turbo model for the main chat - -Model Settings: - --models MODEL List known models which match the (partial) MODEL name - --openai-api-base OPENAI_API_BASE - Specify the api base url [env var: OPENAI_API_BASE] - --openai-api-type OPENAI_API_TYPE - Specify the api_type [env var: OPENAI_API_TYPE] - --openai-api-version OPENAI_API_VERSION - Specify the api_version [env var: OPENAI_API_VERSION] - --openai-api-deployment-id OPENAI_API_DEPLOYMENT_ID - Specify the deployment_id [env var: OPENAI_API_DEPLOYMENT_ID] - --openai-organization-id OPENAI_ORGANIZATION_ID - Specify the OpenAI organization ID [env var: OPENAI_ORGANIZATION_ID] - --edit-format EDIT_FORMAT - Specify what edit format the LLM should use (default depends on model) - --weak-model WEAK_MODEL - Specify the model to use for commit messages and chat history - summarization (default depends on --model) - --show-model-warnings, --no-show-model-warnings - Only work with models that have meta-data available (default: True) - --map-tokens MAP_TOKENS - Max number of tokens to use for repo map, use 0 to disable (default: 1024) - --max-chat-history-tokens MAX_CHAT_HISTORY_TOKENS - Maximum number of tokens to use for chat history. If not specified, uses - the model's max_chat_history_tokens. - --env-file ENV_FILE Specify the .env file to load (default: .env in git root) - -History Files: - --input-history-file INPUT_HISTORY_FILE - Specify the chat input history file (default: .aider.input.history) - --chat-history-file CHAT_HISTORY_FILE - Specify the chat history file (default: .aider.chat.history.md) - --restore-chat-history, --no-restore-chat-history - Restore the previous chat history messages (default: False) - -Output Settings: - --dark-mode Use colors suitable for a dark terminal background (default: False) - --light-mode Use colors suitable for a light terminal background (default: False) - --pretty, --no-pretty - Enable/disable pretty, colorized output (default: True) - --stream, --no-stream - Enable/disable streaming responses (default: True) - --user-input-color USER_INPUT_COLOR - Set the color for user input (default: #00cc00) - --tool-output-color TOOL_OUTPUT_COLOR - Set the color for tool output (default: None) - --tool-error-color TOOL_ERROR_COLOR - Set the color for tool error messages (default: red) - --assistant-output-color ASSISTANT_OUTPUT_COLOR - Set the color for assistant output (default: #0088ff) - --code-theme CODE_THEME - Set the markdown code theme (default: default, other options include - monokai, solarized-dark, solarized-light) - --show-diffs Show diffs when committing changes (default: False) - -Git Settings: - --git, --no-git Enable/disable looking for a git repo (default: True) - --gitignore, --no-gitignore - Enable/disable adding .aider* to .gitignore (default: True) - --aiderignore AIDERIGNORE - Specify the aider ignore file (default: .aiderignore in git root) - --auto-commits, --no-auto-commits - Enable/disable auto commit of LLM changes (default: True) - --dirty-commits, --no-dirty-commits - Enable/disable commits when repo is found dirty (default: True) - --dry-run, --no-dry-run - Perform a dry run without modifying files (default: False) - -Fixing and committing: - --commit Commit all pending changes with a suitable commit message, then exit - --lint Lint and fix provided files, or dirty files if none provided - --lint-cmd LINT_CMD Specify lint commands to run for different languages, eg: "python: flake8 - --select=..." (can be used multiple times) - --auto-lint, --no-auto-lint - Enable/disable automatic linting after changes (default: True) - --test-cmd TEST_CMD Specify command to run tests - --auto-test, --no-auto-test - Enable/disable automatic testing after changes (default: False) - --test Run tests and fix problems found - -Other Settings: - --voice-language VOICE_LANGUAGE - Specify the language for voice using ISO 639-1 code (default: auto) - --version Show the version number and exit - --check-update Check for updates and return status in the exit code - --skip-check-update Skips checking for the update when the program runs - --apply FILE Apply the changes from the given file instead of running the chat (debug) - --yes Always say yes to every confirmation - -v, --verbose Enable verbose output - --show-repo-map Print the repo map and exit (debug) - --show-prompts Print the system prompts and exit (debug) - --message COMMAND, --msg COMMAND, -m COMMAND - Specify a single message to send the LLM, process reply then exit - (disables chat mode) - --message-file MESSAGE_FILE, -f MESSAGE_FILE - Specify a file containing the message to send the LLM, process reply, then - exit (disables chat mode) - --encoding ENCODING Specify the encoding for input and output (default: utf-8) - -c CONFIG_FILE, --config CONFIG_FILE - Specify the config file (default: search for .aider.conf.yml in git root, - cwd or home directory) - --gui, --browser Run aider in your browser - -Args that start with '--' can also be set in a config file (specified via -c). Config file syntax -allows: key=value, flag=true, stuff=[a,b,c] (for details, see syntax at https://goo.gl/R74nmi). In -general, command-line values override environment variables which override config file values -which override defaults. -``` - diff --git a/website/docs/options_ref.md b/website/docs/options_ref.md new file mode 100644 index 000000000..706163892 --- /dev/null +++ b/website/docs/options_ref.md @@ -0,0 +1,170 @@ +--- +parent: Configuration +nav_order: 10 +--- + +## Options reference + +You can use `aider --help` to see all the available options, +or review them below. + + +``` +usage: aider [-h] [--openai-api-key OPENAI_API_KEY] [--anthropic-api-key ANTHROPIC_API_KEY] + [--model MODEL] [--opus] [--sonnet] [--4] [--4o] [--4-turbo] [--35turbo] + [--models MODEL] [--openai-api-base OPENAI_API_BASE] + [--openai-api-type OPENAI_API_TYPE] [--openai-api-version OPENAI_API_VERSION] + [--openai-api-deployment-id OPENAI_API_DEPLOYMENT_ID] + [--openai-organization-id OPENAI_ORGANIZATION_ID] [--edit-format EDIT_FORMAT] + [--weak-model WEAK_MODEL] [--show-model-warnings | --no-show-model-warnings] + [--map-tokens MAP_TOKENS] [--max-chat-history-tokens MAX_CHAT_HISTORY_TOKENS] + [--env-file ENV_FILE] [--input-history-file INPUT_HISTORY_FILE] + [--chat-history-file CHAT_HISTORY_FILE] + [--restore-chat-history | --no-restore-chat-history] [--dark-mode] [--light-mode] + [--pretty | --no-pretty] [--stream | --no-stream] + [--user-input-color USER_INPUT_COLOR] [--tool-output-color TOOL_OUTPUT_COLOR] + [--tool-error-color TOOL_ERROR_COLOR] + [--assistant-output-color ASSISTANT_OUTPUT_COLOR] [--code-theme CODE_THEME] + [--show-diffs] [--git | --no-git] [--gitignore | --no-gitignore] + [--aiderignore AIDERIGNORE] [--auto-commits | --no-auto-commits] + [--dirty-commits | --no-dirty-commits] [--dry-run | --no-dry-run] [--commit] [--lint] + [--lint-cmd LINT_CMD] [--auto-lint | --no-auto-lint] [--test-cmd TEST_CMD] + [--auto-test | --no-auto-test] [--test] [--voice-language VOICE_LANGUAGE] [--version] + [--check-update] [--skip-check-update] [--apply FILE] [--yes] [-v] [--show-repo-map] + [--show-prompts] [--message COMMAND] [--message-file MESSAGE_FILE] + [--encoding ENCODING] [-c CONFIG_FILE] [--gui] + [FILE ...] + +aider is GPT powered coding in your terminal + +options: + -h, --help show this help message and exit + +Main: + FILE files to edit with an LLM (optional) + --openai-api-key OPENAI_API_KEY + Specify the OpenAI API key [env var: OPENAI_API_KEY] + --anthropic-api-key ANTHROPIC_API_KEY + Specify the OpenAI API key [env var: ANTHROPIC_API_KEY] + --model MODEL Specify the model to use for the main chat (default: gpt-4o) + --opus Use claude-3-opus-20240229 model for the main chat + --sonnet Use claude-3-sonnet-20240229 model for the main chat + --4, -4 Use gpt-4-0613 model for the main chat + --4o Use gpt-4o model for the main chat + --4-turbo Use gpt-4-1106-preview model for the main chat + --35turbo, --35-turbo, --3, -3 + Use gpt-3.5-turbo model for the main chat + +Model Settings: + --models MODEL List known models which match the (partial) MODEL name + --openai-api-base OPENAI_API_BASE + Specify the api base url [env var: OPENAI_API_BASE] + --openai-api-type OPENAI_API_TYPE + Specify the api_type [env var: OPENAI_API_TYPE] + --openai-api-version OPENAI_API_VERSION + Specify the api_version [env var: OPENAI_API_VERSION] + --openai-api-deployment-id OPENAI_API_DEPLOYMENT_ID + Specify the deployment_id [env var: OPENAI_API_DEPLOYMENT_ID] + --openai-organization-id OPENAI_ORGANIZATION_ID + Specify the OpenAI organization ID [env var: OPENAI_ORGANIZATION_ID] + --edit-format EDIT_FORMAT + Specify what edit format the LLM should use (default depends on model) + --weak-model WEAK_MODEL + Specify the model to use for commit messages and chat history + summarization (default depends on --model) + --show-model-warnings, --no-show-model-warnings + Only work with models that have meta-data available (default: True) + --map-tokens MAP_TOKENS + Max number of tokens to use for repo map, use 0 to disable (default: 1024) + --max-chat-history-tokens MAX_CHAT_HISTORY_TOKENS + Maximum number of tokens to use for chat history. If not specified, uses + the model's max_chat_history_tokens. + --env-file ENV_FILE Specify the .env file to load (default: .env in git root) + +History Files: + --input-history-file INPUT_HISTORY_FILE + Specify the chat input history file (default: .aider.input.history) + --chat-history-file CHAT_HISTORY_FILE + Specify the chat history file (default: .aider.chat.history.md) + --restore-chat-history, --no-restore-chat-history + Restore the previous chat history messages (default: False) + +Output Settings: + --dark-mode Use colors suitable for a dark terminal background (default: False) + --light-mode Use colors suitable for a light terminal background (default: False) + --pretty, --no-pretty + Enable/disable pretty, colorized output (default: True) + --stream, --no-stream + Enable/disable streaming responses (default: True) + --user-input-color USER_INPUT_COLOR + Set the color for user input (default: #00cc00) + --tool-output-color TOOL_OUTPUT_COLOR + Set the color for tool output (default: None) + --tool-error-color TOOL_ERROR_COLOR + Set the color for tool error messages (default: red) + --assistant-output-color ASSISTANT_OUTPUT_COLOR + Set the color for assistant output (default: #0088ff) + --code-theme CODE_THEME + Set the markdown code theme (default: default, other options include + monokai, solarized-dark, solarized-light) + --show-diffs Show diffs when committing changes (default: False) + +Git Settings: + --git, --no-git Enable/disable looking for a git repo (default: True) + --gitignore, --no-gitignore + Enable/disable adding .aider* to .gitignore (default: True) + --aiderignore AIDERIGNORE + Specify the aider ignore file (default: .aiderignore in git root) + --auto-commits, --no-auto-commits + Enable/disable auto commit of LLM changes (default: True) + --dirty-commits, --no-dirty-commits + Enable/disable commits when repo is found dirty (default: True) + --dry-run, --no-dry-run + Perform a dry run without modifying files (default: False) + +Fixing and committing: + --commit Commit all pending changes with a suitable commit message, then exit + --lint Lint and fix provided files, or dirty files if none provided + --lint-cmd LINT_CMD Specify lint commands to run for different languages, eg: "python: flake8 + --select=..." (can be used multiple times) + --auto-lint, --no-auto-lint + Enable/disable automatic linting after changes (default: True) + --test-cmd TEST_CMD Specify command to run tests + --auto-test, --no-auto-test + Enable/disable automatic testing after changes (default: False) + --test Run tests and fix problems found + +Other Settings: + --voice-language VOICE_LANGUAGE + Specify the language for voice using ISO 639-1 code (default: auto) + --version Show the version number and exit + --check-update Check for updates and return status in the exit code + --skip-check-update Skips checking for the update when the program runs + --apply FILE Apply the changes from the given file instead of running the chat (debug) + --yes Always say yes to every confirmation + -v, --verbose Enable verbose output + --show-repo-map Print the repo map and exit (debug) + --show-prompts Print the system prompts and exit (debug) + --message COMMAND, --msg COMMAND, -m COMMAND + Specify a single message to send the LLM, process reply then exit + (disables chat mode) + --message-file MESSAGE_FILE, -f MESSAGE_FILE + Specify a file containing the message to send the LLM, process reply, then + exit (disables chat mode) + --encoding ENCODING Specify the encoding for input and output (default: utf-8) + -c CONFIG_FILE, --config CONFIG_FILE + Specify the config file (default: search for .aider.conf.yml in git root, + cwd or home directory) + --gui, --browser Run aider in your browser + +Args that start with '--' can also be set in a config file (specified via -c). Config file syntax +allows: key=value, flag=true, stuff=[a,b,c] (for details, see syntax at https://goo.gl/R74nmi). In +general, command-line values override environment variables which override config file values +which override defaults. +``` +