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

style: Update settings section headings to use lowercase

Browse source
This commit is contained in:
Paul Gauthier 2024-12-07 11:51:19 -08:00 • committed by Paul Gauthier (aider)
parent 20042334ff
commit 5705bda818
7 changed files with 43 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

5
aider/website/_includes/special-keys.md
View file

@ -1,3 +1,4 @@
Aider has special support for providing Aider has special support for providing
OpenAI and Anthropic API keys OpenAI and Anthropic API keys
via dedicated via dedicated
@ -16,9 +17,12 @@ All other LLM providers can use one of the following methods to set their
keys: keys:
### API keys on the command line ### API keys on the command line
{: .no_toc }
Use `--api-key provider=<key>` which has the effect of setting the environment variable `PROVIDER_API_KEY=<key>`. So `--api-key gemini=xxx` would set `GEMINI_API_KEY=xxx`. Use `--api-key provider=<key>` which has the effect of setting the environment variable `PROVIDER_API_KEY=<key>`. So `--api-key gemini=xxx` would set `GEMINI_API_KEY=xxx`.
### API keys in a .env file ### API keys in a .env file
{: .no_toc }
The [.env file](/docs/config/dotenv.html) The [.env file](/docs/config/dotenv.html)
is a great place to set API keys and other provider API environment variables: is a great place to set API keys and other provider API environment variables:
@ -30,6 +34,7 @@ DEEPSEEK_API_KEY=baz
``` ```
### API keys in .aider.conf.yml ### API keys in .aider.conf.yml
{: .no_toc }
Or you can set API keys in the Or you can set API keys in the
[`.aider.conf.yml` file](/docs/config/aider_conf.html) [`.aider.conf.yml` file](/docs/config/aider_conf.html)

6
aider/website/assets/sample-analytics.jsonl
View file

@ -1,6 +1,3 @@
{"event": "cli session", "properties": {"main_model": "claude-3-5-sonnet-20241022", "weak_model": "claude-3-5-sonnet-20241022", "editor_model": "claude-3-5-sonnet-20241022", "edit_format": "diff", "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413604}
{"event": "command_chat-mode", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413607}
{"event": "launched", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413666}
{"event": "repo", "properties": {"num_files": 402, "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413666} {"event": "repo", "properties": {"num_files": 402, "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413666}
{"event": "cli session", "properties": {"main_model": "claude-3-5-sonnet-20241022", "weak_model": "claude-3-5-sonnet-20241022", "editor_model": "claude-3-5-sonnet-20241022", "edit_format": "diff", "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413666} {"event": "cli session", "properties": {"main_model": "claude-3-5-sonnet-20241022", "weak_model": "claude-3-5-sonnet-20241022", "editor_model": "claude-3-5-sonnet-20241022", "edit_format": "diff", "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413666}
{"event": "command_chat-mode", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413677} {"event": "command_chat-mode", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.66.1.dev+import"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733413677}
@ -998,3 +995,6 @@
{"event": "message_send_starting", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733599372} {"event": "message_send_starting", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733599372}
{"event": "message_send", "properties": {"main_model": "claude-3-5-sonnet-20241022", "weak_model": "claude-3-5-sonnet-20241022", "editor_model": "claude-3-5-sonnet-20241022", "edit_format": "diff", "prompt_tokens": 16742, "completion_tokens": 381, "total_tokens": 17123, "cost": 0.055941, "total_cost": 1.217385, "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733599381} {"event": "message_send", "properties": {"main_model": "claude-3-5-sonnet-20241022", "weak_model": "claude-3-5-sonnet-20241022", "editor_model": "claude-3-5-sonnet-20241022", "edit_format": "diff", "prompt_tokens": 16742, "completion_tokens": 381, "total_tokens": 17123, "cost": 0.055941, "total_cost": 1.217385, "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733599381}
{"event": "command_drop", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733600357} {"event": "command_drop", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733600357}
{"event": "launched", "properties": {"python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733600710}
{"event": "repo", "properties": {"num_files": 404, "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733600710}
{"event": "exit", "properties": {"reason": "Completed lint/test/commit", "python_version": "3.12.6", "os_platform": "Darwin", "os_release": "23.6.0", "machine": "x86_64", "aider_version": "0.67.1.dev37+gf2d2ab51.d20241206"}, "user_id": "c42c4e6b-f054-44d7-ae1f-6726cc41da88", "time": 1733600720}

14
aider/website/assets/sample.aider.conf.yml
View file

@ -94,7 +94,7 @@
# - zzz # - zzz
################# #################
# Model Settings: # Model settings:
## List known models which match the (partial) MODEL name ## List known models which match the (partial) MODEL name
#list-models: xxx #list-models: xxx
@ -141,7 +141,7 @@
#max-chat-history-tokens: xxx #max-chat-history-tokens: xxx
################# #################
# Cache Settings: # Cache settings:
## Enable caching of prompts (default: False) ## Enable caching of prompts (default: False)
#cache-prompts: false #cache-prompts: false
@ -150,7 +150,7 @@
#cache-keepalive-pings: false #cache-keepalive-pings: false
################### ###################
# Repomap Settings: # Repomap settings:
## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) ## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024)
#map-tokens: xxx #map-tokens: xxx
@ -177,7 +177,7 @@
#llm-history-file: xxx #llm-history-file: xxx
################## ##################
# Output Settings: # Output settings:
## Use colors suitable for a dark terminal background (default: False) ## Use colors suitable for a dark terminal background (default: False)
#dark-mode: false #dark-mode: false
@ -225,7 +225,7 @@
#show-diffs: false #show-diffs: false
############### ###############
# Git Settings: # Git settings:
## Enable/disable looking for a git repo (default: True) ## Enable/disable looking for a git repo (default: True)
#git: true #git: true
@ -362,7 +362,7 @@
#show-prompts: false #show-prompts: false
################# #################
# Voice Settings: # Voice settings:
## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg ## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg
#voice-format: wav #voice-format: wav
@ -374,7 +374,7 @@
#voice-input-device: xxx #voice-input-device: xxx
################# #################
# Other Settings: # Other settings:
## specify a file to edit (can be used multiple times) ## specify a file to edit (can be used multiple times)
#file: xxx #file: xxx

14
aider/website/assets/sample.env
View file

@ -88,7 +88,7 @@
#AIDER_API_KEY= #AIDER_API_KEY=
################# #################
# Model Settings: # Model settings:
## List known models which match the (partial) MODEL name ## List known models which match the (partial) MODEL name
#AIDER_LIST_MODELS= #AIDER_LIST_MODELS=
@ -130,7 +130,7 @@
#AIDER_MAX_CHAT_HISTORY_TOKENS= #AIDER_MAX_CHAT_HISTORY_TOKENS=
################# #################
# Cache Settings: # Cache settings:
## Enable caching of prompts (default: False) ## Enable caching of prompts (default: False)
#AIDER_CACHE_PROMPTS=false #AIDER_CACHE_PROMPTS=false
@ -139,7 +139,7 @@
#AIDER_CACHE_KEEPALIVE_PINGS=false #AIDER_CACHE_KEEPALIVE_PINGS=false
################### ###################
# Repomap Settings: # Repomap settings:
## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) ## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024)
#AIDER_MAP_TOKENS= #AIDER_MAP_TOKENS=
@ -166,7 +166,7 @@
#AIDER_LLM_HISTORY_FILE= #AIDER_LLM_HISTORY_FILE=
################## ##################
# Output Settings: # Output settings:
## Use colors suitable for a dark terminal background (default: False) ## Use colors suitable for a dark terminal background (default: False)
#AIDER_DARK_MODE=false #AIDER_DARK_MODE=false
@ -214,7 +214,7 @@
#AIDER_SHOW_DIFFS=false #AIDER_SHOW_DIFFS=false
############### ###############
# Git Settings: # Git settings:
## Enable/disable looking for a git repo (default: True) ## Enable/disable looking for a git repo (default: True)
#AIDER_GIT=true #AIDER_GIT=true
@ -343,7 +343,7 @@
#AIDER_SHOW_PROMPTS=false #AIDER_SHOW_PROMPTS=false
################# #################
# Voice Settings: # Voice settings:
## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg ## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg
#AIDER_VOICE_FORMAT=wav #AIDER_VOICE_FORMAT=wav
@ -355,7 +355,7 @@
#AIDER_VOICE_INPUT_DEVICE= #AIDER_VOICE_INPUT_DEVICE=
################# #################
# Other Settings: # Other settings:
## specify a file to edit (can be used multiple times) ## specify a file to edit (can be used multiple times)
#AIDER_FILE= #AIDER_FILE=

14
aider/website/docs/config/aider_conf.md
View file

@ -150,7 +150,7 @@ cog.outl("```")
# - zzz # - zzz
################# #################
# Model Settings: # Model settings:
## List known models which match the (partial) MODEL name ## List known models which match the (partial) MODEL name
#list-models: xxx #list-models: xxx
@ -197,7 +197,7 @@ cog.outl("```")
#max-chat-history-tokens: xxx #max-chat-history-tokens: xxx
################# #################
# Cache Settings: # Cache settings:
## Enable caching of prompts (default: False) ## Enable caching of prompts (default: False)
#cache-prompts: false #cache-prompts: false
@ -206,7 +206,7 @@ cog.outl("```")
#cache-keepalive-pings: false #cache-keepalive-pings: false
################### ###################
# Repomap Settings: # Repomap settings:
## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) ## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024)
#map-tokens: xxx #map-tokens: xxx
@ -233,7 +233,7 @@ cog.outl("```")
#llm-history-file: xxx #llm-history-file: xxx
################## ##################
# Output Settings: # Output settings:
## Use colors suitable for a dark terminal background (default: False) ## Use colors suitable for a dark terminal background (default: False)
#dark-mode: false #dark-mode: false
@ -281,7 +281,7 @@ cog.outl("```")
#show-diffs: false #show-diffs: false
############### ###############
# Git Settings: # Git settings:
## Enable/disable looking for a git repo (default: True) ## Enable/disable looking for a git repo (default: True)
#git: true #git: true
@ -418,7 +418,7 @@ cog.outl("```")
#show-prompts: false #show-prompts: false
################# #################
# Voice Settings: # Voice settings:
## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg ## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg
#voice-format: wav #voice-format: wav
@ -430,7 +430,7 @@ cog.outl("```")
#voice-input-device: xxx #voice-input-device: xxx
################# #################
# Other Settings: # Other settings:
## specify a file to edit (can be used multiple times) ## specify a file to edit (can be used multiple times)
#file: xxx #file: xxx

14
aider/website/docs/config/dotenv.md
View file

@ -130,7 +130,7 @@ cog.outl("```")
#AIDER_API_KEY= #AIDER_API_KEY=
################# #################
# Model Settings: # Model settings:
## List known models which match the (partial) MODEL name ## List known models which match the (partial) MODEL name
#AIDER_LIST_MODELS= #AIDER_LIST_MODELS=
@ -172,7 +172,7 @@ cog.outl("```")
#AIDER_MAX_CHAT_HISTORY_TOKENS= #AIDER_MAX_CHAT_HISTORY_TOKENS=
################# #################
# Cache Settings: # Cache settings:
## Enable caching of prompts (default: False) ## Enable caching of prompts (default: False)
#AIDER_CACHE_PROMPTS=false #AIDER_CACHE_PROMPTS=false
@ -181,7 +181,7 @@ cog.outl("```")
#AIDER_CACHE_KEEPALIVE_PINGS=false #AIDER_CACHE_KEEPALIVE_PINGS=false
################### ###################
# Repomap Settings: # Repomap settings:
## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) ## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024)
#AIDER_MAP_TOKENS= #AIDER_MAP_TOKENS=
@ -208,7 +208,7 @@ cog.outl("```")
#AIDER_LLM_HISTORY_FILE= #AIDER_LLM_HISTORY_FILE=
################## ##################
# Output Settings: # Output settings:
## Use colors suitable for a dark terminal background (default: False) ## Use colors suitable for a dark terminal background (default: False)
#AIDER_DARK_MODE=false #AIDER_DARK_MODE=false
@ -256,7 +256,7 @@ cog.outl("```")
#AIDER_SHOW_DIFFS=false #AIDER_SHOW_DIFFS=false
############### ###############
# Git Settings: # Git settings:
## Enable/disable looking for a git repo (default: True) ## Enable/disable looking for a git repo (default: True)
#AIDER_GIT=true #AIDER_GIT=true
@ -385,7 +385,7 @@ cog.outl("```")
#AIDER_SHOW_PROMPTS=false #AIDER_SHOW_PROMPTS=false
################# #################
# Voice Settings: # Voice settings:
## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg ## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg
#AIDER_VOICE_FORMAT=wav #AIDER_VOICE_FORMAT=wav
@ -397,7 +397,7 @@ cog.outl("```")
#AIDER_VOICE_INPUT_DEVICE= #AIDER_VOICE_INPUT_DEVICE=
################# #################
# Other Settings: # Other settings:
## specify a file to edit (can be used multiple times) ## specify a file to edit (can be used multiple times)
#AIDER_FILE= #AIDER_FILE=

15
aider/website/docs/config/options.md
View file

@ -14,7 +14,6 @@ or review them below.
{:toc} {:toc}
## LLM keys ## LLM keys
{: .no_toc }
{% include special-keys.md %} {% include special-keys.md %}
@ -189,7 +188,7 @@ Set an API key for a provider (eg: --api-key provider=<key> sets PROVIDER_API_KE
Default: [] Default: []
Environment variable: `AIDER_API_KEY` Environment variable: `AIDER_API_KEY`
## Model Settings: ## Model settings:
### `--list-models MODEL` ### `--list-models MODEL`
List known models which match the (partial) MODEL name List known models which match the (partial) MODEL name
@ -259,7 +258,7 @@ Aliases:
Soft limit on tokens for chat history, after which summarization begins. If unspecified, defaults to the model's max_chat_history_tokens. Soft limit on tokens for chat history, after which summarization begins. If unspecified, defaults to the model's max_chat_history_tokens.
Environment variable: `AIDER_MAX_CHAT_HISTORY_TOKENS` Environment variable: `AIDER_MAX_CHAT_HISTORY_TOKENS`
## Cache Settings: ## Cache settings:
### `--cache-prompts` ### `--cache-prompts`
Enable caching of prompts (default: False) Enable caching of prompts (default: False)
@ -274,7 +273,7 @@ Number of times to ping at 5min intervals to keep prompt cache warm (default: 0)
Default: 0 Default: 0
Environment variable: `AIDER_CACHE_KEEPALIVE_PINGS` Environment variable: `AIDER_CACHE_KEEPALIVE_PINGS`
## Repomap Settings: ## Repomap settings:
### `--map-tokens VALUE` ### `--map-tokens VALUE`
Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) Suggested number of tokens to use for repo map, use 0 to disable (default: 1024)
@ -314,7 +313,7 @@ Aliases:
Log the conversation with the LLM to this file (for example, .aider.llm.history) Log the conversation with the LLM to this file (for example, .aider.llm.history)
Environment variable: `AIDER_LLM_HISTORY_FILE` Environment variable: `AIDER_LLM_HISTORY_FILE`
## Output Settings: ## Output settings:
### `--dark-mode` ### `--dark-mode`
Use colors suitable for a dark terminal background (default: False) Use colors suitable for a dark terminal background (default: False)
@ -392,7 +391,7 @@ Show diffs when committing changes (default: False)
Default: False Default: False
Environment variable: `AIDER_SHOW_DIFFS` Environment variable: `AIDER_SHOW_DIFFS`
## Git Settings: ## Git settings:
### `--git` ### `--git`
Enable/disable looking for a git repo (default: True) Enable/disable looking for a git repo (default: True)
@ -651,7 +650,7 @@ Print the system prompts and exit (debug)
Default: False Default: False
Environment variable: `AIDER_SHOW_PROMPTS` Environment variable: `AIDER_SHOW_PROMPTS`
## Voice Settings: ## Voice settings:
### `--voice-format VOICE_FORMAT` ### `--voice-format VOICE_FORMAT`
Audio format for voice recording (default: wav). webm and mp3 require ffmpeg Audio format for voice recording (default: wav). webm and mp3 require ffmpeg
@ -667,7 +666,7 @@ Environment variable: `AIDER_VOICE_LANGUAGE`
Specify the input device name for voice recording Specify the input device name for voice recording
Environment variable: `AIDER_VOICE_INPUT_DEVICE` Environment variable: `AIDER_VOICE_INPUT_DEVICE`
## Other Settings: ## Other settings:
### `--file FILE` ### `--file FILE`
specify a file to edit (can be used multiple times) specify a file to edit (can be used multiple times)