|
| 1 | +########################################################## |
| 2 | +# Sample .aider.conf.yml |
| 3 | +# This file lists *all* the valid configuration entries. |
| 4 | +# Place in your home dir, or at the root of your git repo. |
| 5 | +########################################################## |
| 6 | + |
| 7 | +# Note: You can only put OpenAI and Anthropic API keys in the yaml |
| 8 | +# config file. Keys for all APIs can be stored in a .env file |
| 9 | +# https://aider.chat/docs/config/dotenv.html |
| 10 | + |
| 11 | +########## |
| 12 | +# options: |
| 13 | + |
| 14 | +## show this help message and exit |
| 15 | +#help: xxx |
| 16 | + |
| 17 | +####### |
| 18 | +# Main: |
| 19 | + |
| 20 | +## Specify the OpenAI API key |
| 21 | +#openai-api-key: xxx |
| 22 | + |
| 23 | +## Specify the Anthropic API key |
| 24 | +#anthropic-api-key: xxx |
| 25 | + |
| 26 | +## Specify the model to use for the main chat |
| 27 | +#model: xxx |
| 28 | + |
| 29 | +## Use claude-3-opus-20240229 model for the main chat |
| 30 | +#opus: false |
| 31 | + |
| 32 | +## Use claude-3-5-sonnet-20240620 model for the main chat |
| 33 | +sonnet: true |
| 34 | + |
| 35 | +## Use gpt-4-0613 model for the main chat |
| 36 | +#4: false |
| 37 | + |
| 38 | +## Use gpt-4o-2024-08-06 model for the main chat |
| 39 | +#4o: false |
| 40 | + |
| 41 | +## Use gpt-4o-mini model for the main chat |
| 42 | +#mini: false |
| 43 | + |
| 44 | +## Use gpt-4-1106-preview model for the main chat |
| 45 | +#4-turbo: false |
| 46 | + |
| 47 | +## Use gpt-3.5-turbo model for the main chat |
| 48 | +#35turbo: false |
| 49 | + |
| 50 | +## Use deepseek/deepseek-coder model for the main chat |
| 51 | +#deepseek: false |
| 52 | + |
| 53 | +## Use o1-mini model for the main chat |
| 54 | +#o1-mini: false |
| 55 | + |
| 56 | +## Use o1-preview model for the main chat |
| 57 | +#o1-preview: false |
| 58 | + |
| 59 | +################# |
| 60 | +# Model Settings: |
| 61 | + |
| 62 | +## List known models which match the (partial) MODEL name |
| 63 | +#list-models: xxx |
| 64 | + |
| 65 | +## Specify the api base url |
| 66 | +#openai-api-base: xxx |
| 67 | + |
| 68 | +## Specify the api_type |
| 69 | +#openai-api-type: xxx |
| 70 | + |
| 71 | +## Specify the api_version |
| 72 | +#openai-api-version: xxx |
| 73 | + |
| 74 | +## Specify the deployment_id |
| 75 | +#openai-api-deployment-id: xxx |
| 76 | + |
| 77 | +## Specify the OpenAI organization ID |
| 78 | +#openai-organization-id: xxx |
| 79 | + |
| 80 | +## Specify a file with aider model settings for unknown models |
| 81 | +#model-settings-file: .aider.model.settings.yml |
| 82 | + |
| 83 | +## Specify a file with context window and costs for unknown models |
| 84 | +#model-metadata-file: .aider.model.metadata.json |
| 85 | + |
| 86 | +## Verify the SSL cert when connecting to models (default: True) |
| 87 | +#verify-ssl: true |
| 88 | + |
| 89 | +## Specify what edit format the LLM should use (default depends on model) |
| 90 | +#edit-format: xxx |
| 91 | + |
| 92 | +## Use architect edit format for the main chat |
| 93 | +#architect: false |
| 94 | + |
| 95 | +## Specify the model to use for commit messages and chat history summarization (default depends on --model) |
| 96 | +#weak-model: xxx |
| 97 | + |
| 98 | +## Specify the model to use for editor tasks (default depends on --model) |
| 99 | +#editor-model: xxx |
| 100 | + |
| 101 | +## Specify the edit format for the editor model (default: depends on editor model) |
| 102 | +#editor-edit-format: xxx |
| 103 | + |
| 104 | +## Only work with models that have meta-data available (default: True) |
| 105 | +#show-model-warnings: true |
| 106 | + |
| 107 | +## Soft limit on tokens for chat history, after which summarization begins. If unspecified, defaults to the model's max_chat_history_tokens. |
| 108 | +#max-chat-history-tokens: xxx |
| 109 | + |
| 110 | +## Specify the .env file to load (default: .env in git root) |
| 111 | +#env-file: .env |
| 112 | + |
| 113 | +################# |
| 114 | +# Cache Settings: |
| 115 | + |
| 116 | +## Enable caching of prompts (default: False) |
| 117 | +#cache-prompts: false |
| 118 | + |
| 119 | +## Number of times to ping at 5min intervals to keep prompt cache warm (default: 0) |
| 120 | +#cache-keepalive-pings: false |
| 121 | + |
| 122 | +################### |
| 123 | +# Repomap Settings: |
| 124 | + |
| 125 | +## Suggested number of tokens to use for repo map, use 0 to disable (default: 1024) |
| 126 | +#map-tokens: xxx |
| 127 | + |
| 128 | +## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto) |
| 129 | +#map-refresh: auto |
| 130 | + |
| 131 | +## Multiplier for map tokens when no files are specified (default: 2) |
| 132 | +#map-multiplier-no-files: true |
| 133 | + |
| 134 | +################ |
| 135 | +# History Files: |
| 136 | + |
| 137 | +## Specify the chat input history file (default: .aider.input.history) |
| 138 | +#input-history-file: .aider.input.history |
| 139 | + |
| 140 | +## Specify the chat history file (default: .aider.chat.history.md) |
| 141 | +#chat-history-file: .aider.chat.history.md |
| 142 | + |
| 143 | +## Restore the previous chat history messages (default: False) |
| 144 | +#restore-chat-history: false |
| 145 | + |
| 146 | +## Log the conversation with the LLM to this file (for example, .aider.llm.history) |
| 147 | +#llm-history-file: xxx |
| 148 | + |
| 149 | +################## |
| 150 | +# Output Settings: |
| 151 | + |
| 152 | +## Use colors suitable for a dark terminal background (default: False) |
| 153 | +#dark-mode: false |
| 154 | + |
| 155 | +## Use colors suitable for a light terminal background (default: False) |
| 156 | +#light-mode: false |
| 157 | + |
| 158 | +## Enable/disable pretty, colorized output (default: True) |
| 159 | +#pretty: true |
| 160 | + |
| 161 | +## Enable/disable streaming responses (default: True) |
| 162 | +#stream: true |
| 163 | + |
| 164 | +## Set the color for user input (default: #00cc00) |
| 165 | +#user-input-color: #00cc00 |
| 166 | + |
| 167 | +## Set the color for tool output (default: None) |
| 168 | +#tool-output-color: xxx |
| 169 | + |
| 170 | +## Set the color for tool error messages (default: #FF2222) |
| 171 | +#tool-error-color: #FF2222 |
| 172 | + |
| 173 | +## Set the color for tool warning messages (default: #FFA500) |
| 174 | +#tool-warning-color: #FFA500 |
| 175 | + |
| 176 | +## Set the color for assistant output (default: #0088ff) |
| 177 | +#assistant-output-color: #0088ff |
| 178 | + |
| 179 | +## Set the color for the completion menu (default: terminal's default text color) |
| 180 | +#completion-menu-color: xxx |
| 181 | + |
| 182 | +## Set the background color for the completion menu (default: terminal's default background color) |
| 183 | +#completion-menu-bg-color: xxx |
| 184 | + |
| 185 | +## Set the color for the current item in the completion menu (default: terminal's default background color) |
| 186 | +#completion-menu-current-color: xxx |
| 187 | + |
| 188 | +## Set the background color for the current item in the completion menu (default: terminal's default text color) |
| 189 | +#completion-menu-current-bg-color: xxx |
| 190 | + |
| 191 | +## Set the markdown code theme (default: default, other options include monokai, solarized-dark, solarized-light) |
| 192 | +#code-theme: default |
| 193 | + |
| 194 | +## Show diffs when committing changes (default: False) |
| 195 | +#show-diffs: false |
| 196 | + |
| 197 | +############### |
| 198 | +# Git Settings: |
| 199 | + |
| 200 | +## Enable/disable looking for a git repo (default: True) |
| 201 | +#git: true |
| 202 | + |
| 203 | +## Enable/disable adding .aider* to .gitignore (default: True) |
| 204 | +#gitignore: true |
| 205 | + |
| 206 | +## Specify the aider ignore file (default: .aiderignore in git root) |
| 207 | +#aiderignore: .aiderignore |
| 208 | + |
| 209 | +## Only consider files in the current subtree of the git repository |
| 210 | +#subtree-only: false |
| 211 | + |
| 212 | +## Enable/disable auto commit of LLM changes (default: True) |
| 213 | +auto-commits: false |
| 214 | + |
| 215 | +## Enable/disable commits when repo is found dirty (default: True) |
| 216 | +#dirty-commits: true |
| 217 | + |
| 218 | +## Attribute aider code changes in the git author name (default: True) |
| 219 | +#attribute-author: true |
| 220 | + |
| 221 | +## Attribute aider commits in the git committer name (default: True) |
| 222 | +#attribute-committer: true |
| 223 | + |
| 224 | +## Prefix commit messages with 'aider: ' if aider authored the changes (default: False) |
| 225 | +#attribute-commit-message-author: false |
| 226 | + |
| 227 | +## Prefix all commit messages with 'aider: ' (default: False) |
| 228 | +#attribute-commit-message-committer: false |
| 229 | + |
| 230 | +## Commit all pending changes with a suitable commit message, then exit |
| 231 | +#commit: false |
| 232 | + |
| 233 | +## Specify a custom prompt for generating commit messages |
| 234 | +#commit-prompt: xxx |
| 235 | + |
| 236 | +## Perform a dry run without modifying files (default: False) |
| 237 | +#dry-run: false |
| 238 | + |
| 239 | +## Skip the sanity check for the git repository (default: False) |
| 240 | +#skip-sanity-check-repo: false |
| 241 | + |
| 242 | +######################## |
| 243 | +# Fixing and committing: |
| 244 | + |
| 245 | +## Lint and fix provided files, or dirty files if none provided |
| 246 | +#lint: false |
| 247 | + |
| 248 | +## Specify lint commands to run for different languages, eg: "python: flake8 --select=..." (can be used multiple times) |
| 249 | +#lint-cmd: xxx |
| 250 | +## Specify multiple values like this: |
| 251 | +#lint-cmd: |
| 252 | +# - xxx |
| 253 | +# - yyy |
| 254 | +# - zzz |
| 255 | + |
| 256 | +## Enable/disable automatic linting after changes (default: True) |
| 257 | +#auto-lint: true |
| 258 | + |
| 259 | +## Specify command to run tests |
| 260 | +#test-cmd: xxx |
| 261 | + |
| 262 | +## Enable/disable automatic testing after changes (default: False) |
| 263 | +#auto-test: false |
| 264 | + |
| 265 | +## Run tests and fix problems found |
| 266 | +#test: false |
| 267 | + |
| 268 | +################# |
| 269 | +# Other Settings: |
| 270 | + |
| 271 | +## specify a file to edit (can be used multiple times) |
| 272 | +#file: xxx |
| 273 | +## Specify multiple values like this: |
| 274 | +#file: |
| 275 | +# - xxx |
| 276 | +# - yyy |
| 277 | +# - zzz |
| 278 | + |
| 279 | +## specify a read-only file (can be used multiple times) |
| 280 | +#read: xxx |
| 281 | +## Specify multiple values like this: |
| 282 | +#read: |
| 283 | +# - xxx |
| 284 | +# - yyy |
| 285 | +# - zzz |
| 286 | + |
| 287 | +## Use VI editing mode in the terminal (default: False) |
| 288 | +#vim: false |
| 289 | + |
| 290 | +## Specify the language to use in the chat (default: None, uses system settings) |
| 291 | +#chat-language: xxx |
| 292 | + |
| 293 | +## Show the version number and exit |
| 294 | +#version: xxx |
| 295 | + |
| 296 | +## Check for updates and return status in the exit code |
| 297 | +#just-check-update: false |
| 298 | + |
| 299 | +## Check for new aider versions on launch |
| 300 | +#check-update: true |
| 301 | + |
| 302 | +## Install the latest version from the main branch |
| 303 | +#install-main-branch: false |
| 304 | + |
| 305 | +## Upgrade aider to the latest version from PyPI |
| 306 | +#upgrade: false |
| 307 | + |
| 308 | +## Apply the changes from the given file instead of running the chat (debug) |
| 309 | +#apply: xxx |
| 310 | + |
| 311 | +## Always say yes to every confirmation |
| 312 | +#yes-always: false |
| 313 | + |
| 314 | +## Enable verbose output |
| 315 | +verbose: false |
| 316 | + |
| 317 | +## Print the repo map and exit (debug) |
| 318 | +#show-repo-map: false |
| 319 | + |
| 320 | +## Print the system prompts and exit (debug) |
| 321 | +#show-prompts: false |
| 322 | + |
| 323 | +## Do all startup activities then exit before accepting user input (debug) |
| 324 | +#exit: false |
| 325 | + |
| 326 | +## Specify a single message to send the LLM, process reply then exit (disables chat mode) |
| 327 | +#message: xxx |
| 328 | + |
| 329 | +## Specify a file containing the message to send the LLM, process reply, then exit (disables chat mode) |
| 330 | +#message-file: xxx |
| 331 | + |
| 332 | +## Specify the encoding for input and output (default: utf-8) |
| 333 | +#encoding: utf-8 |
| 334 | + |
| 335 | +## Specify the config file (default: search for .aider.conf.yml in git root, cwd or home directory) |
| 336 | +#config: xxx |
| 337 | + |
| 338 | +## Run aider in your browser |
| 339 | +#gui: false |
| 340 | + |
| 341 | +## Enable/disable suggesting shell commands (default: True) |
| 342 | +#suggest-shell-commands: true |
| 343 | + |
| 344 | +################# |
| 345 | +# Voice Settings: |
| 346 | + |
| 347 | +## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg |
| 348 | +#voice-format: wav |
| 349 | + |
| 350 | +## Specify the language for voice using ISO 639-1 code (default: auto) |
| 351 | +#voice-language: en |
0 commit comments