From 1de8c13974af4a65d94d087e4e5148d53b396212 Mon Sep 17 00:00:00 2001 From: Paul Gauthier Date: Mon, 23 Sep 2024 10:30:22 -0700 Subject: [PATCH] copy --- aider/website/assets/sample.aider.conf.yml | 41 ++++++----- aider/website/assets/sample.env | 41 ++++++----- aider/website/docs/config/aider_conf.md | 41 ++++++----- aider/website/docs/config/dotenv.md | 41 ++++++----- aider/website/docs/config/options.md | 68 ++++++++++--------- aider/website/docs/troubleshooting/imports.md | 21 +++--- 6 files changed, 150 insertions(+), 103 deletions(-) diff --git a/aider/website/assets/sample.aider.conf.yml b/aider/website/assets/sample.aider.conf.yml index 220c80179..ccee5d16d 100644 --- a/aider/website/assets/sample.aider.conf.yml +++ b/aider/website/assets/sample.aider.conf.yml @@ -89,11 +89,14 @@ ## Only work with models that have meta-data available (default: True) #show-model-warnings: true -## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) -#map-tokens: xxx +## Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. +#max-chat-history-tokens: xxx -## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) -#map-refresh: auto +## Specify the .env file to load (default: .env in git root) +#env-file: .env + +################# +# Cache Settings: ## Enable caching of prompts (default: False) #cache-prompts: false @@ -101,15 +104,18 @@ ## Number of times to ping at 5min intervals to keep prompt cache warm (default: 0) #cache-keepalive-pings: false +################### +# Repomap Settings: + +## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) +#map-tokens: xxx + +## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) +#map-refresh: auto + ## Multiplier for map tokens when no files are specified (default: 2) #map-multiplier-no-files: true -## Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. -#max-chat-history-tokens: xxx - -## Specify the .env file to load (default: .env in git root) -#env-file: .env - ################ # History Files: @@ -242,12 +248,6 @@ ## Use VI editing mode in the terminal (default: False) #vim: false -## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg -#voice-format: wav - -## Specify the language for voice using ISO 639-1 code (default: auto) -#voice-language: en - ## Specify the language to use in the chat (default: None, uses system settings) #chat-language: xxx @@ -301,3 +301,12 @@ ## Enable/disable suggesting shell commands (default: True) #suggest-shell-commands: true + +################# +# Voice Settings: + +## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg +#voice-format: wav + +## Specify the language for voice using ISO 639-1 code (default: auto) +#voice-language: en diff --git a/aider/website/assets/sample.env b/aider/website/assets/sample.env index 2612d4fa6..c9c851bf1 100644 --- a/aider/website/assets/sample.env +++ b/aider/website/assets/sample.env @@ -93,11 +93,14 @@ ## Only work with models that have meta-data available (default: True) #AIDER_SHOW_MODEL_WARNINGS=true -## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) -#AIDER_MAP_TOKENS= +## Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. +#AIDER_MAX_CHAT_HISTORY_TOKENS= -## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) -#AIDER_MAP_REFRESH=auto +## Specify the .env file to load (default: .env in git root) +#AIDER_ENV_FILE=.env + +################# +# Cache Settings: ## Enable caching of prompts (default: False) #AIDER_CACHE_PROMPTS=false @@ -105,15 +108,18 @@ ## Number of times to ping at 5min intervals to keep prompt cache warm (default: 0) #AIDER_CACHE_KEEPALIVE_PINGS=false +################### +# Repomap Settings: + +## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) +#AIDER_MAP_TOKENS= + +## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) +#AIDER_MAP_REFRESH=auto + ## Multiplier for map tokens when no files are specified (default: 2) #AIDER_MAP_MULTIPLIER_NO_FILES=true -## Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. -#AIDER_MAX_CHAT_HISTORY_TOKENS= - -## Specify the .env file to load (default: .env in git root) -#AIDER_ENV_FILE=.env - ################ # History Files: @@ -240,12 +246,6 @@ ## Use VI editing mode in the terminal (default: False) #AIDER_VIM=false -## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg -#AIDER_VOICE_FORMAT=wav - -## Specify the language for voice using ISO 639-1 code (default: auto) -#AIDER_VOICE_LANGUAGE=en - ## Specify the language to use in the chat (default: None, uses system settings) #AIDER_CHAT_LANGUAGE= @@ -293,3 +293,12 @@ ## Enable/disable suggesting shell commands (default: True) #AIDER_SUGGEST_SHELL_COMMANDS=true + +################# +# Voice Settings: + +## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg +#AIDER_VOICE_FORMAT=wav + +## Specify the language for voice using ISO 639-1 code (default: auto) +#AIDER_VOICE_LANGUAGE=en diff --git a/aider/website/docs/config/aider_conf.md b/aider/website/docs/config/aider_conf.md index 2e05b86e5..711e8fc36 100644 --- a/aider/website/docs/config/aider_conf.md +++ b/aider/website/docs/config/aider_conf.md @@ -137,11 +137,14 @@ cog.outl("```") ## Only work with models that have meta-data available (default: True) #show-model-warnings: true -## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) -#map-tokens: xxx +## Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. +#max-chat-history-tokens: xxx -## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) -#map-refresh: auto +## Specify the .env file to load (default: .env in git root) +#env-file: .env + +################# +# Cache Settings: ## Enable caching of prompts (default: False) #cache-prompts: false @@ -149,15 +152,18 @@ cog.outl("```") ## Number of times to ping at 5min intervals to keep prompt cache warm (default: 0) #cache-keepalive-pings: false +################### +# Repomap Settings: + +## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) +#map-tokens: xxx + +## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) +#map-refresh: auto + ## Multiplier for map tokens when no files are specified (default: 2) #map-multiplier-no-files: true -## Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. -#max-chat-history-tokens: xxx - -## Specify the .env file to load (default: .env in git root) -#env-file: .env - ################ # History Files: @@ -290,12 +296,6 @@ cog.outl("```") ## Use VI editing mode in the terminal (default: False) #vim: false -## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg -#voice-format: wav - -## Specify the language for voice using ISO 639-1 code (default: auto) -#voice-language: en - ## Specify the language to use in the chat (default: None, uses system settings) #chat-language: xxx @@ -349,5 +349,14 @@ cog.outl("```") ## Enable/disable suggesting shell commands (default: True) #suggest-shell-commands: true + +################# +# Voice Settings: + +## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg +#voice-format: wav + +## Specify the language for voice using ISO 639-1 code (default: auto) +#voice-language: en ``` diff --git a/aider/website/docs/config/dotenv.md b/aider/website/docs/config/dotenv.md index b9d34a513..10805d923 100644 --- a/aider/website/docs/config/dotenv.md +++ b/aider/website/docs/config/dotenv.md @@ -135,11 +135,14 @@ cog.outl("```") ## Only work with models that have meta-data available (default: True) #AIDER_SHOW_MODEL_WARNINGS=true -## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) -#AIDER_MAP_TOKENS= +## Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. +#AIDER_MAX_CHAT_HISTORY_TOKENS= -## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) -#AIDER_MAP_REFRESH=auto +## Specify the .env file to load (default: .env in git root) +#AIDER_ENV_FILE=.env + +################# +# Cache Settings: ## Enable caching of prompts (default: False) #AIDER_CACHE_PROMPTS=false @@ -147,15 +150,18 @@ cog.outl("```") ## Number of times to ping at 5min intervals to keep prompt cache warm (default: 0) #AIDER_CACHE_KEEPALIVE_PINGS=false +################### +# Repomap Settings: + +## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) +#AIDER_MAP_TOKENS= + +## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) +#AIDER_MAP_REFRESH=auto + ## Multiplier for map tokens when no files are specified (default: 2) #AIDER_MAP_MULTIPLIER_NO_FILES=true -## Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. -#AIDER_MAX_CHAT_HISTORY_TOKENS= - -## Specify the .env file to load (default: .env in git root) -#AIDER_ENV_FILE=.env - ################ # History Files: @@ -282,12 +288,6 @@ cog.outl("```") ## Use VI editing mode in the terminal (default: False) #AIDER_VIM=false -## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg -#AIDER_VOICE_FORMAT=wav - -## Specify the language for voice using ISO 639-1 code (default: auto) -#AIDER_VOICE_LANGUAGE=en - ## Specify the language to use in the chat (default: None, uses system settings) #AIDER_CHAT_LANGUAGE= @@ -335,6 +335,15 @@ cog.outl("```") ## Enable/disable suggesting shell commands (default: True) #AIDER_SUGGEST_SHELL_COMMANDS=true + +################# +# Voice Settings: + +## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg +#AIDER_VOICE_FORMAT=wav + +## Specify the language for voice using ISO 639-1 code (default: auto) +#AIDER_VOICE_LANGUAGE=en ``` diff --git a/aider/website/docs/config/options.md b/aider/website/docs/config/options.md index c6003c166..5d10eaa94 100644 --- a/aider/website/docs/config/options.md +++ b/aider/website/docs/config/options.md @@ -35,10 +35,10 @@ usage: aider [-h] [--openai-api-key] [--anthropic-api-key] [--model] [--verify-ssl | --no-verify-ssl] [--edit-format] [--weak-model] [--show-model-warnings | --no-show-model-warnings] - [--map-tokens] [--map-refresh] - [--cache-prompts | --no-cache-prompts] - [--cache-keepalive-pings] [--map-multiplier-no-files] [--max-chat-history-tokens] [--env-file] + [--cache-prompts | --no-cache-prompts] + [--cache-keepalive-pings] [--map-tokens] + [--map-refresh] [--map-multiplier-no-files] [--input-history-file] [--chat-history-file] [--restore-chat-history | --no-restore-chat-history] [--llm-history-file] [--dark-mode] [--light-mode] @@ -57,14 +57,14 @@ usage: aider [-h] [--openai-api-key] [--anthropic-api-key] [--model] [--commit] [--commit-prompt] [--dry-run | --no-dry-run] [--lint] [--lint-cmd] [--auto-lint | --no-auto-lint] [--test-cmd] [--auto-test | --no-auto-test] [--test] - [--file] [--read] [--vim] [--voice-format] - [--voice-language] [--chat-language] [--version] + [--file] [--read] [--vim] [--chat-language] [--version] [--just-check-update] [--check-update | --no-check-update] [--install-main-branch] [--upgrade] [--apply] [--yes] [-v] [--show-repo-map] [--show-prompts] [--exit] [--message] [--message-file] [--encoding] [-c] [--gui] [--suggest-shell-commands | --no-suggest-shell-commands] + [--voice-format] [--voice-language] ``` @@ -196,14 +196,16 @@ Aliases: - `--show-model-warnings` - `--no-show-model-warnings` -### `--map-tokens VALUE` -Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) -Environment variable: `AIDER_MAP_TOKENS` +### `--max-chat-history-tokens VALUE` +Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. +Environment variable: `AIDER_MAX_CHAT_HISTORY_TOKENS` -### `--map-refresh VALUE` -Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) -Default: auto -Environment variable: `AIDER_MAP_REFRESH` +### `--env-file ENV_FILE` +Specify the .env file to load (default: .env in git root) +Default: .env +Environment variable: `AIDER_ENV_FILE` + +## Cache Settings: ### `--cache-prompts` Enable caching of prompts (default: False) @@ -218,20 +220,22 @@ Number of times to ping at 5min intervals to keep prompt cache warm (default: 0) Default: 0 Environment variable: `AIDER_CACHE_KEEPALIVE_PINGS` +## Repomap Settings: + +### `--map-tokens VALUE` +Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) +Environment variable: `AIDER_MAP_TOKENS` + +### `--map-refresh VALUE` +Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) +Default: auto +Environment variable: `AIDER_MAP_REFRESH` + ### `--map-multiplier-no-files VALUE` Multiplier for map tokens when no files are specified (default: 2) Default: 2 Environment variable: `AIDER_MAP_MULTIPLIER_NO_FILES` -### `--max-chat-history-tokens VALUE` -Maximum number of tokens to use for chat history. If not specified, uses the model's max_chat_history_tokens. -Environment variable: `AIDER_MAX_CHAT_HISTORY_TOKENS` - -### `--env-file ENV_FILE` -Specify the .env file to load (default: .env in git root) -Default: .env -Environment variable: `AIDER_ENV_FILE` - ## History Files: ### `--input-history-file INPUT_HISTORY_FILE` @@ -464,16 +468,6 @@ Use VI editing mode in the terminal (default: False) Default: False Environment variable: `AIDER_VIM` -### `--voice-format VOICE_FORMAT` -Audio format for voice recording (default: wav). webm and mp3 require ffmpeg -Default: wav -Environment variable: `AIDER_VOICE_FORMAT` - -### `--voice-language VOICE_LANGUAGE` -Specify the language for voice using ISO 639-1 code (default: auto) -Default: en -Environment variable: `AIDER_VOICE_LANGUAGE` - ### `--chat-language CHAT_LANGUAGE` Specify the language to use in the chat (default: None, uses system settings) Environment variable: `AIDER_CHAT_LANGUAGE` @@ -579,4 +573,16 @@ Environment variable: `AIDER_SUGGEST_SHELL_COMMANDS` Aliases: - `--suggest-shell-commands` - `--no-suggest-shell-commands` + +## Voice Settings: + +### `--voice-format VOICE_FORMAT` +Audio format for voice recording (default: wav). webm and mp3 require ffmpeg +Default: wav +Environment variable: `AIDER_VOICE_FORMAT` + +### `--voice-language VOICE_LANGUAGE` +Specify the language for voice using ISO 639-1 code (default: auto) +Default: en +Environment variable: `AIDER_VOICE_LANGUAGE` diff --git a/aider/website/docs/troubleshooting/imports.md b/aider/website/docs/troubleshooting/imports.md index 6773cba76..4caad8902 100644 --- a/aider/website/docs/troubleshooting/imports.md +++ b/aider/website/docs/troubleshooting/imports.md @@ -3,16 +3,19 @@ parent: Troubleshooting nav_order: 28 --- -# Import errors +# Dependency versions Aider expects to be installed via `pip` or `pipx`, which will install -all of its required dependencies. -If aider reports `ImportErrors`, this probably means it has been installed -incorrectly. +correct versions of all of its required dependencies. + +If you've been linked to this doc from a GitHub issue, +or if aider is reporting `ImportErrors` +it is likely that your +aider install is using incorrect dependencies. ## Install with pipx -If you are having problems with import errors you should consider +If you are having dependency problems you should consider [installing aider using pipx](/docs/install/pipx.html). This will ensure that aider is installed in its own python environment, with the correct set of dependencies. @@ -21,9 +24,11 @@ with the correct set of dependencies. Package managers often install aider with the wrong dependencies, leading to import errors and other problems. -It is not recommended to install aider with these tools. -Instead, consider -[installing aider using pipx](/docs/install/pipx.html). +The recommended way to +install aider is with +[pip](/docs/install/install.html) +or +[pipx](/docs/install/pipx.html). ## Dependency versions matter