chatmcp-cli 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (228) hide show
  1. aider/__init__.py +20 -0
  2. aider/__main__.py +4 -0
  3. aider/_version.py +21 -0
  4. aider/analytics.py +250 -0
  5. aider/args.py +926 -0
  6. aider/args_formatter.py +228 -0
  7. aider/coders/__init__.py +34 -0
  8. aider/coders/architect_coder.py +48 -0
  9. aider/coders/architect_prompts.py +40 -0
  10. aider/coders/ask_coder.py +9 -0
  11. aider/coders/ask_prompts.py +35 -0
  12. aider/coders/base_coder.py +2483 -0
  13. aider/coders/base_prompts.py +60 -0
  14. aider/coders/chat_chunks.py +64 -0
  15. aider/coders/context_coder.py +53 -0
  16. aider/coders/context_prompts.py +75 -0
  17. aider/coders/editblock_coder.py +657 -0
  18. aider/coders/editblock_fenced_coder.py +10 -0
  19. aider/coders/editblock_fenced_prompts.py +143 -0
  20. aider/coders/editblock_func_coder.py +141 -0
  21. aider/coders/editblock_func_prompts.py +27 -0
  22. aider/coders/editblock_prompts.py +174 -0
  23. aider/coders/editor_diff_fenced_coder.py +9 -0
  24. aider/coders/editor_diff_fenced_prompts.py +11 -0
  25. aider/coders/editor_editblock_coder.py +8 -0
  26. aider/coders/editor_editblock_prompts.py +18 -0
  27. aider/coders/editor_whole_coder.py +8 -0
  28. aider/coders/editor_whole_prompts.py +10 -0
  29. aider/coders/help_coder.py +16 -0
  30. aider/coders/help_prompts.py +46 -0
  31. aider/coders/patch_coder.py +706 -0
  32. aider/coders/patch_prompts.py +161 -0
  33. aider/coders/search_replace.py +757 -0
  34. aider/coders/shell.py +37 -0
  35. aider/coders/single_wholefile_func_coder.py +102 -0
  36. aider/coders/single_wholefile_func_prompts.py +27 -0
  37. aider/coders/udiff_coder.py +429 -0
  38. aider/coders/udiff_prompts.py +115 -0
  39. aider/coders/udiff_simple.py +14 -0
  40. aider/coders/udiff_simple_prompts.py +25 -0
  41. aider/coders/wholefile_coder.py +144 -0
  42. aider/coders/wholefile_func_coder.py +134 -0
  43. aider/coders/wholefile_func_prompts.py +27 -0
  44. aider/coders/wholefile_prompts.py +67 -0
  45. aider/commands.py +1665 -0
  46. aider/copypaste.py +72 -0
  47. aider/deprecated.py +126 -0
  48. aider/diffs.py +128 -0
  49. aider/dump.py +29 -0
  50. aider/editor.py +147 -0
  51. aider/exceptions.py +107 -0
  52. aider/format_settings.py +26 -0
  53. aider/gui.py +545 -0
  54. aider/help.py +163 -0
  55. aider/help_pats.py +19 -0
  56. aider/history.py +143 -0
  57. aider/io.py +1175 -0
  58. aider/linter.py +304 -0
  59. aider/llm.py +47 -0
  60. aider/main.py +1267 -0
  61. aider/mdstream.py +243 -0
  62. aider/models.py +1286 -0
  63. aider/onboarding.py +428 -0
  64. aider/openrouter.py +128 -0
  65. aider/prompts.py +64 -0
  66. aider/queries/tree-sitter-language-pack/README.md +7 -0
  67. aider/queries/tree-sitter-language-pack/arduino-tags.scm +5 -0
  68. aider/queries/tree-sitter-language-pack/c-tags.scm +9 -0
  69. aider/queries/tree-sitter-language-pack/chatito-tags.scm +16 -0
  70. aider/queries/tree-sitter-language-pack/commonlisp-tags.scm +122 -0
  71. aider/queries/tree-sitter-language-pack/cpp-tags.scm +15 -0
  72. aider/queries/tree-sitter-language-pack/csharp-tags.scm +26 -0
  73. aider/queries/tree-sitter-language-pack/d-tags.scm +26 -0
  74. aider/queries/tree-sitter-language-pack/dart-tags.scm +92 -0
  75. aider/queries/tree-sitter-language-pack/elisp-tags.scm +5 -0
  76. aider/queries/tree-sitter-language-pack/elixir-tags.scm +54 -0
  77. aider/queries/tree-sitter-language-pack/elm-tags.scm +19 -0
  78. aider/queries/tree-sitter-language-pack/gleam-tags.scm +41 -0
  79. aider/queries/tree-sitter-language-pack/go-tags.scm +42 -0
  80. aider/queries/tree-sitter-language-pack/java-tags.scm +20 -0
  81. aider/queries/tree-sitter-language-pack/javascript-tags.scm +88 -0
  82. aider/queries/tree-sitter-language-pack/lua-tags.scm +34 -0
  83. aider/queries/tree-sitter-language-pack/ocaml-tags.scm +115 -0
  84. aider/queries/tree-sitter-language-pack/ocaml_interface-tags.scm +98 -0
  85. aider/queries/tree-sitter-language-pack/pony-tags.scm +39 -0
  86. aider/queries/tree-sitter-language-pack/properties-tags.scm +5 -0
  87. aider/queries/tree-sitter-language-pack/python-tags.scm +14 -0
  88. aider/queries/tree-sitter-language-pack/r-tags.scm +21 -0
  89. aider/queries/tree-sitter-language-pack/racket-tags.scm +12 -0
  90. aider/queries/tree-sitter-language-pack/ruby-tags.scm +64 -0
  91. aider/queries/tree-sitter-language-pack/rust-tags.scm +60 -0
  92. aider/queries/tree-sitter-language-pack/solidity-tags.scm +43 -0
  93. aider/queries/tree-sitter-language-pack/swift-tags.scm +51 -0
  94. aider/queries/tree-sitter-language-pack/udev-tags.scm +20 -0
  95. aider/queries/tree-sitter-languages/README.md +23 -0
  96. aider/queries/tree-sitter-languages/c-tags.scm +9 -0
  97. aider/queries/tree-sitter-languages/c_sharp-tags.scm +46 -0
  98. aider/queries/tree-sitter-languages/cpp-tags.scm +15 -0
  99. aider/queries/tree-sitter-languages/dart-tags.scm +91 -0
  100. aider/queries/tree-sitter-languages/elisp-tags.scm +8 -0
  101. aider/queries/tree-sitter-languages/elixir-tags.scm +54 -0
  102. aider/queries/tree-sitter-languages/elm-tags.scm +19 -0
  103. aider/queries/tree-sitter-languages/go-tags.scm +30 -0
  104. aider/queries/tree-sitter-languages/hcl-tags.scm +77 -0
  105. aider/queries/tree-sitter-languages/java-tags.scm +20 -0
  106. aider/queries/tree-sitter-languages/javascript-tags.scm +88 -0
  107. aider/queries/tree-sitter-languages/kotlin-tags.scm +27 -0
  108. aider/queries/tree-sitter-languages/ocaml-tags.scm +115 -0
  109. aider/queries/tree-sitter-languages/ocaml_interface-tags.scm +98 -0
  110. aider/queries/tree-sitter-languages/php-tags.scm +26 -0
  111. aider/queries/tree-sitter-languages/python-tags.scm +12 -0
  112. aider/queries/tree-sitter-languages/ql-tags.scm +26 -0
  113. aider/queries/tree-sitter-languages/ruby-tags.scm +64 -0
  114. aider/queries/tree-sitter-languages/rust-tags.scm +60 -0
  115. aider/queries/tree-sitter-languages/scala-tags.scm +65 -0
  116. aider/queries/tree-sitter-languages/typescript-tags.scm +41 -0
  117. aider/reasoning_tags.py +82 -0
  118. aider/repo.py +623 -0
  119. aider/repomap.py +847 -0
  120. aider/report.py +200 -0
  121. aider/resources/__init__.py +3 -0
  122. aider/resources/model-metadata.json +468 -0
  123. aider/resources/model-settings.yml +1767 -0
  124. aider/run_cmd.py +132 -0
  125. aider/scrape.py +284 -0
  126. aider/sendchat.py +61 -0
  127. aider/special.py +203 -0
  128. aider/urls.py +17 -0
  129. aider/utils.py +338 -0
  130. aider/versioncheck.py +113 -0
  131. aider/voice.py +187 -0
  132. aider/waiting.py +221 -0
  133. aider/watch.py +318 -0
  134. aider/watch_prompts.py +12 -0
  135. aider/website/Gemfile +8 -0
  136. aider/website/_includes/blame.md +162 -0
  137. aider/website/_includes/get-started.md +22 -0
  138. aider/website/_includes/help-tip.md +5 -0
  139. aider/website/_includes/help.md +24 -0
  140. aider/website/_includes/install.md +5 -0
  141. aider/website/_includes/keys.md +4 -0
  142. aider/website/_includes/model-warnings.md +67 -0
  143. aider/website/_includes/multi-line.md +22 -0
  144. aider/website/_includes/python-m-aider.md +5 -0
  145. aider/website/_includes/recording.css +228 -0
  146. aider/website/_includes/recording.md +34 -0
  147. aider/website/_includes/replit-pipx.md +9 -0
  148. aider/website/_includes/works-best.md +1 -0
  149. aider/website/_sass/custom/custom.scss +103 -0
  150. aider/website/docs/config/adv-model-settings.md +1881 -0
  151. aider/website/docs/config/aider_conf.md +527 -0
  152. aider/website/docs/config/api-keys.md +90 -0
  153. aider/website/docs/config/dotenv.md +478 -0
  154. aider/website/docs/config/editor.md +127 -0
  155. aider/website/docs/config/model-aliases.md +103 -0
  156. aider/website/docs/config/options.md +843 -0
  157. aider/website/docs/config/reasoning.md +209 -0
  158. aider/website/docs/config.md +44 -0
  159. aider/website/docs/faq.md +378 -0
  160. aider/website/docs/git.md +76 -0
  161. aider/website/docs/index.md +47 -0
  162. aider/website/docs/install/codespaces.md +39 -0
  163. aider/website/docs/install/docker.md +57 -0
  164. aider/website/docs/install/optional.md +100 -0
  165. aider/website/docs/install/replit.md +8 -0
  166. aider/website/docs/install.md +115 -0
  167. aider/website/docs/languages.md +264 -0
  168. aider/website/docs/legal/contributor-agreement.md +111 -0
  169. aider/website/docs/legal/privacy.md +104 -0
  170. aider/website/docs/llms/anthropic.md +77 -0
  171. aider/website/docs/llms/azure.md +48 -0
  172. aider/website/docs/llms/bedrock.md +132 -0
  173. aider/website/docs/llms/cohere.md +34 -0
  174. aider/website/docs/llms/deepseek.md +32 -0
  175. aider/website/docs/llms/gemini.md +49 -0
  176. aider/website/docs/llms/github.md +105 -0
  177. aider/website/docs/llms/groq.md +36 -0
  178. aider/website/docs/llms/lm-studio.md +39 -0
  179. aider/website/docs/llms/ollama.md +75 -0
  180. aider/website/docs/llms/openai-compat.md +39 -0
  181. aider/website/docs/llms/openai.md +58 -0
  182. aider/website/docs/llms/openrouter.md +78 -0
  183. aider/website/docs/llms/other.md +103 -0
  184. aider/website/docs/llms/vertex.md +50 -0
  185. aider/website/docs/llms/warnings.md +10 -0
  186. aider/website/docs/llms/xai.md +53 -0
  187. aider/website/docs/llms.md +54 -0
  188. aider/website/docs/more/analytics.md +122 -0
  189. aider/website/docs/more/edit-formats.md +116 -0
  190. aider/website/docs/more/infinite-output.md +137 -0
  191. aider/website/docs/more-info.md +8 -0
  192. aider/website/docs/recordings/auto-accept-architect.md +31 -0
  193. aider/website/docs/recordings/dont-drop-original-read-files.md +35 -0
  194. aider/website/docs/recordings/index.md +21 -0
  195. aider/website/docs/recordings/model-accepts-settings.md +69 -0
  196. aider/website/docs/recordings/tree-sitter-language-pack.md +80 -0
  197. aider/website/docs/repomap.md +112 -0
  198. aider/website/docs/scripting.md +100 -0
  199. aider/website/docs/troubleshooting/aider-not-found.md +24 -0
  200. aider/website/docs/troubleshooting/edit-errors.md +76 -0
  201. aider/website/docs/troubleshooting/imports.md +62 -0
  202. aider/website/docs/troubleshooting/models-and-keys.md +54 -0
  203. aider/website/docs/troubleshooting/support.md +79 -0
  204. aider/website/docs/troubleshooting/token-limits.md +96 -0
  205. aider/website/docs/troubleshooting/warnings.md +12 -0
  206. aider/website/docs/troubleshooting.md +11 -0
  207. aider/website/docs/usage/browser.md +57 -0
  208. aider/website/docs/usage/caching.md +49 -0
  209. aider/website/docs/usage/commands.md +132 -0
  210. aider/website/docs/usage/conventions.md +119 -0
  211. aider/website/docs/usage/copypaste.md +121 -0
  212. aider/website/docs/usage/images-urls.md +48 -0
  213. aider/website/docs/usage/lint-test.md +118 -0
  214. aider/website/docs/usage/modes.md +211 -0
  215. aider/website/docs/usage/not-code.md +179 -0
  216. aider/website/docs/usage/notifications.md +87 -0
  217. aider/website/docs/usage/tips.md +79 -0
  218. aider/website/docs/usage/tutorials.md +30 -0
  219. aider/website/docs/usage/voice.md +121 -0
  220. aider/website/docs/usage/watch.md +294 -0
  221. aider/website/docs/usage.md +92 -0
  222. aider/website/share/index.md +101 -0
  223. chatmcp_cli-0.1.0.dist-info/METADATA +502 -0
  224. chatmcp_cli-0.1.0.dist-info/RECORD +228 -0
  225. chatmcp_cli-0.1.0.dist-info/WHEEL +5 -0
  226. chatmcp_cli-0.1.0.dist-info/entry_points.txt +3 -0
  227. chatmcp_cli-0.1.0.dist-info/licenses/LICENSE.txt +202 -0
  228. chatmcp_cli-0.1.0.dist-info/top_level.txt +1 -0
@@ -0,0 +1,527 @@
1
+ ---
2
+ parent: Configuration
3
+ nav_order: 15
4
+ description: How to configure aider with a YAML config file.
5
+ ---
6
+
7
+ # YAML config file
8
+
9
+ Most of aider's options can be set in an `.aider.conf.yml` file.
10
+ Aider will look for a this file in these locations:
11
+
12
+ - Your home directory.
13
+ - The root of your git repo.
14
+ - The current directory.
15
+
16
+ If the files above exist, they will be loaded in that order. Files loaded last will take priority.
17
+
18
+ You can also specify the `--config <filename>` parameter, which will only load the one config file.
19
+
20
+ {% include keys.md %}
21
+
22
+ ## A note on lists
23
+
24
+ Lists of values can be specified either as a bulleted list:
25
+
26
+ ```
27
+ read:
28
+ - CONVENTIONS.md
29
+ - anotherfile.txt
30
+ - thirdfile.py
31
+ ```
32
+
33
+ Or lists can be specified using commas and square brackets:
34
+
35
+ ```
36
+ read: [CONVENTIONS.md, anotherfile.txt, thirdfile.py]
37
+ ```
38
+
39
+ ## Sample YAML config file
40
+
41
+ Below is a sample of the YAML config file, which you
42
+ can also
43
+ [download from GitHub](https://github.com/Aider-AI/aider/blob/main/aider/website/assets/sample.aider.conf.yml).
44
+
45
+ <!--[[[cog
46
+ from aider.args import get_sample_yaml
47
+ from pathlib import Path
48
+ text=get_sample_yaml()
49
+ Path("aider/website/assets/sample.aider.conf.yml").write_text(text)
50
+ cog.outl("```")
51
+ cog.out(text)
52
+ cog.outl("```")
53
+ ]]]-->
54
+ ```
55
+ ##########################################################
56
+ # Sample .aider.conf.yml
57
+ # This file lists *all* the valid configuration entries.
58
+ # Place in your home dir, or at the root of your git repo.
59
+ ##########################################################
60
+
61
+ # Note: You can only put OpenAI and Anthropic API keys in the YAML
62
+ # config file. Keys for all APIs can be stored in a .env file
63
+ # https://aider.chat/docs/config/dotenv.html
64
+
65
+ ##########
66
+ # options:
67
+
68
+ ## show this help message and exit
69
+ #help: xxx
70
+
71
+ #############
72
+ # Main model:
73
+
74
+ ## Specify the model to use for the main chat
75
+ #model: xxx
76
+
77
+ ########################
78
+ # API Keys and settings:
79
+
80
+ ## Specify the OpenAI API key
81
+ #openai-api-key: xxx
82
+
83
+ ## Specify the Anthropic API key
84
+ #anthropic-api-key: xxx
85
+
86
+ ## Specify the api base url
87
+ #openai-api-base: xxx
88
+
89
+ ## (deprecated, use --set-env OPENAI_API_TYPE=<value>)
90
+ #openai-api-type: xxx
91
+
92
+ ## (deprecated, use --set-env OPENAI_API_VERSION=<value>)
93
+ #openai-api-version: xxx
94
+
95
+ ## (deprecated, use --set-env OPENAI_API_DEPLOYMENT_ID=<value>)
96
+ #openai-api-deployment-id: xxx
97
+
98
+ ## (deprecated, use --set-env OPENAI_ORGANIZATION=<value>)
99
+ #openai-organization-id: xxx
100
+
101
+ ## Set an environment variable (to control API settings, can be used multiple times)
102
+ #set-env: xxx
103
+ ## Specify multiple values like this:
104
+ #set-env:
105
+ # - xxx
106
+ # - yyy
107
+ # - zzz
108
+
109
+ ## Set an API key for a provider (eg: --api-key provider=<key> sets PROVIDER_API_KEY=<key>)
110
+ #api-key: xxx
111
+ ## Specify multiple values like this:
112
+ #api-key:
113
+ # - xxx
114
+ # - yyy
115
+ # - zzz
116
+
117
+ #################
118
+ # Model settings:
119
+
120
+ ## List known models which match the (partial) MODEL name
121
+ #list-models: xxx
122
+
123
+ ## Specify a file with aider model settings for unknown models
124
+ #model-settings-file: .aider.model.settings.yml
125
+
126
+ ## Specify a file with context window and costs for unknown models
127
+ #model-metadata-file: .aider.model.metadata.json
128
+
129
+ ## Add a model alias (can be used multiple times)
130
+ #alias: xxx
131
+ ## Specify multiple values like this:
132
+ #alias:
133
+ # - xxx
134
+ # - yyy
135
+ # - zzz
136
+
137
+ ## Set the reasoning_effort API parameter (default: not set)
138
+ #reasoning-effort: xxx
139
+
140
+ ## Set the thinking token budget for models that support it (default: not set)
141
+ #thinking-tokens: xxx
142
+
143
+ ## Verify the SSL cert when connecting to models (default: True)
144
+ #verify-ssl: true
145
+
146
+ ## Timeout in seconds for API calls (default: None)
147
+ #timeout: xxx
148
+
149
+ ## Specify what edit format the LLM should use (default depends on model)
150
+ #edit-format: xxx
151
+
152
+ ## Use architect edit format for the main chat
153
+ #architect: false
154
+
155
+ ## Enable/disable automatic acceptance of architect changes (default: True)
156
+ #auto-accept-architect: true
157
+
158
+ ## Specify the model to use for commit messages and chat history summarization (default depends on --model)
159
+ #weak-model: xxx
160
+
161
+ ## Specify the model to use for editor tasks (default depends on --model)
162
+ #editor-model: xxx
163
+
164
+ ## Specify the edit format for the editor model (default: depends on editor model)
165
+ #editor-edit-format: xxx
166
+
167
+ ## Only work with models that have meta-data available (default: True)
168
+ #show-model-warnings: true
169
+
170
+ ## Check if model accepts settings like reasoning_effort/thinking_tokens (default: True)
171
+ #check-model-accepts-settings: true
172
+
173
+ ## Soft limit on tokens for chat history, after which summarization begins. If unspecified, defaults to the model's max_chat_history_tokens.
174
+ #max-chat-history-tokens: xxx
175
+
176
+ #################
177
+ # Cache settings:
178
+
179
+ ## Enable caching of prompts (default: False)
180
+ #cache-prompts: false
181
+
182
+ ## Number of times to ping at 5min intervals to keep prompt cache warm (default: 0)
183
+ #cache-keepalive-pings: false
184
+
185
+ ###################
186
+ # Repomap settings:
187
+
188
+ ## Suggested number of tokens to use for repo map, use 0 to disable
189
+ #map-tokens: xxx
190
+
191
+ ## Control how often the repo map is refreshed. Options: auto, always, files, manual (default: auto)
192
+ #map-refresh: auto
193
+
194
+ ## Multiplier for map tokens when no files are specified (default: 2)
195
+ #map-multiplier-no-files: true
196
+
197
+ ################
198
+ # History Files:
199
+
200
+ ## Specify the chat input history file (default: .aider.input.history)
201
+ #input-history-file: .aider.input.history
202
+
203
+ ## Specify the chat history file (default: .aider.chat.history.md)
204
+ #chat-history-file: .aider.chat.history.md
205
+
206
+ ## Restore the previous chat history messages (default: False)
207
+ #restore-chat-history: false
208
+
209
+ ## Log the conversation with the LLM to this file (for example, .aider.llm.history)
210
+ #llm-history-file: xxx
211
+
212
+ ##################
213
+ # Output settings:
214
+
215
+ ## Use colors suitable for a dark terminal background (default: False)
216
+ #dark-mode: false
217
+
218
+ ## Use colors suitable for a light terminal background (default: False)
219
+ #light-mode: false
220
+
221
+ ## Enable/disable pretty, colorized output (default: True)
222
+ #pretty: true
223
+
224
+ ## Enable/disable streaming responses (default: True)
225
+ #stream: true
226
+
227
+ ## Set the color for user input (default: #00cc00)
228
+ #user-input-color: "#00cc00"
229
+
230
+ ## Set the color for tool output (default: None)
231
+ #tool-output-color: "xxx"
232
+
233
+ ## Set the color for tool error messages (default: #FF2222)
234
+ #tool-error-color: "#FF2222"
235
+
236
+ ## Set the color for tool warning messages (default: #FFA500)
237
+ #tool-warning-color: "#FFA500"
238
+
239
+ ## Set the color for assistant output (default: #0088ff)
240
+ #assistant-output-color: "#0088ff"
241
+
242
+ ## Set the color for the completion menu (default: terminal's default text color)
243
+ #completion-menu-color: "xxx"
244
+
245
+ ## Set the background color for the completion menu (default: terminal's default background color)
246
+ #completion-menu-bg-color: "xxx"
247
+
248
+ ## Set the color for the current item in the completion menu (default: terminal's default background color)
249
+ #completion-menu-current-color: "xxx"
250
+
251
+ ## Set the background color for the current item in the completion menu (default: terminal's default text color)
252
+ #completion-menu-current-bg-color: "xxx"
253
+
254
+ ## Set the markdown code theme (default: default, other options include monokai, solarized-dark, solarized-light, or a Pygments builtin style, see https://pygments.org/styles for available themes)
255
+ #code-theme: default
256
+
257
+ ## Show diffs when committing changes (default: False)
258
+ #show-diffs: false
259
+
260
+ ###############
261
+ # Git settings:
262
+
263
+ ## Enable/disable looking for a git repo (default: True)
264
+ #git: true
265
+
266
+ ## Enable/disable adding .aider* to .gitignore (default: True)
267
+ #gitignore: true
268
+
269
+ ## Specify the aider ignore file (default: .aiderignore in git root)
270
+ #aiderignore: .aiderignore
271
+
272
+ ## Only consider files in the current subtree of the git repository
273
+ #subtree-only: false
274
+
275
+ ## Enable/disable auto commit of LLM changes (default: True)
276
+ #auto-commits: true
277
+
278
+ ## Enable/disable commits when repo is found dirty (default: True)
279
+ #dirty-commits: true
280
+
281
+ ## Attribute aider code changes in the git author name (default: True). If explicitly set to True, overrides --attribute-co-authored-by precedence.
282
+ #attribute-author: xxx
283
+
284
+ ## Attribute aider commits in the git committer name (default: True). If explicitly set to True, overrides --attribute-co-authored-by precedence for aider edits.
285
+ #attribute-committer: xxx
286
+
287
+ ## Prefix commit messages with 'aider: ' if aider authored the changes (default: False)
288
+ #attribute-commit-message-author: false
289
+
290
+ ## Prefix all commit messages with 'aider: ' (default: False)
291
+ #attribute-commit-message-committer: false
292
+
293
+ ## Attribute aider edits using the Co-authored-by trailer in the commit message (default: False). If True, this takes precedence over default --attribute-author and --attribute-committer behavior unless they are explicitly set to True.
294
+ #attribute-co-authored-by: false
295
+
296
+ ## Enable/disable git pre-commit hooks with --no-verify (default: False)
297
+ #git-commit-verify: false
298
+
299
+ ## Commit all pending changes with a suitable commit message, then exit
300
+ #commit: false
301
+
302
+ ## Specify a custom prompt for generating commit messages
303
+ #commit-prompt: xxx
304
+
305
+ ## Perform a dry run without modifying files (default: False)
306
+ #dry-run: false
307
+
308
+ ## Skip the sanity check for the git repository (default: False)
309
+ #skip-sanity-check-repo: false
310
+
311
+ ## Enable/disable watching files for ai coding comments (default: False)
312
+ #watch-files: false
313
+
314
+ ########################
315
+ # Fixing and committing:
316
+
317
+ ## Lint and fix provided files, or dirty files if none provided
318
+ #lint: false
319
+
320
+ ## Specify lint commands to run for different languages, eg: "python: flake8 --select=..." (can be used multiple times)
321
+ #lint-cmd: xxx
322
+ ## Specify multiple values like this:
323
+ #lint-cmd:
324
+ # - xxx
325
+ # - yyy
326
+ # - zzz
327
+
328
+ ## Enable/disable automatic linting after changes (default: True)
329
+ #auto-lint: true
330
+
331
+ ## Specify command to run tests
332
+ #test-cmd: xxx
333
+
334
+ ## Enable/disable automatic testing after changes (default: False)
335
+ #auto-test: false
336
+
337
+ ## Run tests, fix problems found and then exit
338
+ #test: false
339
+
340
+ ############
341
+ # Analytics:
342
+
343
+ ## Enable/disable analytics for current session (default: random)
344
+ #analytics: xxx
345
+
346
+ ## Specify a file to log analytics events
347
+ #analytics-log: xxx
348
+
349
+ ## Permanently disable analytics
350
+ #analytics-disable: false
351
+
352
+ ############
353
+ # Upgrading:
354
+
355
+ ## Check for updates and return status in the exit code
356
+ #just-check-update: false
357
+
358
+ ## Check for new aider versions on launch
359
+ #check-update: true
360
+
361
+ ## Show release notes on first run of new version (default: None, ask user)
362
+ #show-release-notes: xxx
363
+
364
+ ## Install the latest version from the main branch
365
+ #install-main-branch: false
366
+
367
+ ## Upgrade aider to the latest version from PyPI
368
+ #upgrade: false
369
+
370
+ ## Show the version number and exit
371
+ #version: xxx
372
+
373
+ ########
374
+ # Modes:
375
+
376
+ ## Specify a single message to send the LLM, process reply then exit (disables chat mode)
377
+ #message: xxx
378
+
379
+ ## Specify a file containing the message to send the LLM, process reply, then exit (disables chat mode)
380
+ #message-file: xxx
381
+
382
+ ## Run aider in your browser (default: False)
383
+ #gui: false
384
+
385
+ ## Enable automatic copy/paste of chat between aider and web UI (default: False)
386
+ #copy-paste: false
387
+
388
+ ## Apply the changes from the given file instead of running the chat (debug)
389
+ #apply: xxx
390
+
391
+ ## Apply clipboard contents as edits using the main model's editor format
392
+ #apply-clipboard-edits: false
393
+
394
+ ## Do all startup activities then exit before accepting user input (debug)
395
+ #exit: false
396
+
397
+ ## Print the repo map and exit (debug)
398
+ #show-repo-map: false
399
+
400
+ ## Print the system prompts and exit (debug)
401
+ #show-prompts: false
402
+
403
+ #################
404
+ # Voice settings:
405
+
406
+ ## Audio format for voice recording (default: wav). webm and mp3 require ffmpeg
407
+ #voice-format: wav
408
+
409
+ ## Specify the language for voice using ISO 639-1 code (default: auto)
410
+ #voice-language: en
411
+
412
+ ## Specify the input device name for voice recording
413
+ #voice-input-device: xxx
414
+
415
+ #################
416
+ # Other settings:
417
+
418
+ ## Never prompt for or attempt to install Playwright for web scraping (default: False).
419
+ #disable-playwright: false
420
+
421
+ ## specify a file to edit (can be used multiple times)
422
+ #file: xxx
423
+ ## Specify multiple values like this:
424
+ #file:
425
+ # - xxx
426
+ # - yyy
427
+ # - zzz
428
+
429
+ ## specify a read-only file (can be used multiple times)
430
+ #read: xxx
431
+ ## Specify multiple values like this:
432
+ #read:
433
+ # - xxx
434
+ # - yyy
435
+ # - zzz
436
+
437
+ ## Use VI editing mode in the terminal (default: False)
438
+ #vim: false
439
+
440
+ ## Specify the language to use in the chat (default: None, uses system settings)
441
+ #chat-language: xxx
442
+
443
+ ## Specify the language to use in the commit message (default: None, user language)
444
+ #commit-language: xxx
445
+
446
+ ## Always say yes to every confirmation
447
+ #yes-always: false
448
+
449
+ ## Enable verbose output
450
+ #verbose: false
451
+
452
+ ## Load and execute /commands from a file on launch
453
+ #load: xxx
454
+
455
+ ## Specify the encoding for input and output (default: utf-8)
456
+ #encoding: utf-8
457
+
458
+ ## Line endings to use when writing files (default: platform)
459
+ #line-endings: platform
460
+
461
+ ## Specify the config file (default: search for .aider.conf.yml in git root, cwd or home directory)
462
+ #config: xxx
463
+
464
+ ## Specify the .env file to load (default: .env in git root)
465
+ #env-file: .env
466
+
467
+ ## Enable/disable suggesting shell commands (default: True)
468
+ #suggest-shell-commands: true
469
+
470
+ ## Enable/disable fancy input with history and completion (default: True)
471
+ #fancy-input: true
472
+
473
+ ## Enable/disable multi-line input mode with Meta-Enter to submit (default: False)
474
+ #multiline: false
475
+
476
+ ## Enable/disable terminal bell notifications when LLM responses are ready (default: False)
477
+ #notifications: false
478
+
479
+ ## Specify a command to run for notifications instead of the terminal bell. If not specified, a default command for your OS may be used.
480
+ #notifications-command: xxx
481
+
482
+ ## Enable/disable detection and offering to add URLs to chat (default: True)
483
+ #detect-urls: true
484
+
485
+ ## Specify which editor to use for the /editor command
486
+ #editor: xxx
487
+
488
+ ## Print shell completion script for the specified SHELL and exit. Supported shells: bash, tcsh, zsh. Example: aider --shell-completions bash
489
+ #shell-completions: xxx
490
+
491
+ ############################
492
+ # Deprecated model settings:
493
+
494
+ ## Use claude-3-opus-20240229 model for the main chat (deprecated, use --model)
495
+ #opus: false
496
+
497
+ ## Use anthropic/claude-3-7-sonnet-20250219 model for the main chat (deprecated, use --model)
498
+ #sonnet: false
499
+
500
+ ## Use claude-3-5-haiku-20241022 model for the main chat (deprecated, use --model)
501
+ #haiku: false
502
+
503
+ ## Use gpt-4-0613 model for the main chat (deprecated, use --model)
504
+ #4: false
505
+
506
+ ## Use gpt-4o model for the main chat (deprecated, use --model)
507
+ #4o: false
508
+
509
+ ## Use gpt-4o-mini model for the main chat (deprecated, use --model)
510
+ #mini: false
511
+
512
+ ## Use gpt-4-1106-preview model for the main chat (deprecated, use --model)
513
+ #4-turbo: false
514
+
515
+ ## Use gpt-3.5-turbo model for the main chat (deprecated, use --model)
516
+ #35turbo: false
517
+
518
+ ## Use deepseek/deepseek-chat model for the main chat (deprecated, use --model)
519
+ #deepseek: false
520
+
521
+ ## Use o1-mini model for the main chat (deprecated, use --model)
522
+ #o1-mini: false
523
+
524
+ ## Use o1-preview model for the main chat (deprecated, use --model)
525
+ #o1-preview: false
526
+ ```
527
+ <!--[[[end]]]-->
@@ -0,0 +1,90 @@
1
+ ---
2
+ parent: Configuration
3
+ nav_order: 5
4
+ description: Setting API keys for API providers.
5
+ ---
6
+
7
+ # API Keys
8
+
9
+ Aider lets you specify API keys in a few ways:
10
+
11
+ - On the command line
12
+ - As environment variables
13
+ - In a `.env` file
14
+ - In your `.aider.conf.yml` config file
15
+
16
+ ---
17
+
18
+ ## OpenAI and Anthropic
19
+
20
+ Aider has special support for providing
21
+ OpenAI and Anthropic API keys
22
+ via dedicated switches and configuration options.
23
+ Settings keys for other providers works a bit differently, see below.
24
+
25
+ #### Command line
26
+
27
+ You can set OpenAI and Anthropic API keys via
28
+ [command line switches](/docs/config/options.html#api-keys-and-settings)
29
+ `--openai-api-key` and `--anthropic-api-key`.
30
+
31
+
32
+ #### Environment variables or .env file
33
+
34
+ You can also store them in environment variables or a
35
+ [.env file](/docs/config/dotenv.html), which also works
36
+ for every API provider:
37
+
38
+ ```
39
+ OPENAI_API_KEY=<key>
40
+ ANTHROPIC_API_KEY=<key>
41
+ ```
42
+
43
+ #### YAML config file
44
+ You can also set those API keys via special entries in the
45
+ [YAML config file](/docs/config/aider_conf.html), like this:
46
+
47
+ ```yaml
48
+ openai-api-key: <key>
49
+ anthropic-api-key: <key>
50
+ ```
51
+
52
+
53
+ ---
54
+
55
+ ## Other API providers
56
+
57
+ All other LLM providers can use one of these other methods to set their API keys.
58
+
59
+ #### Command line
60
+ {: .no_toc }
61
+
62
+ 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`.
63
+
64
+ #### Environment variables or .env file
65
+ {: .no_toc }
66
+
67
+ You can set API keys in environment variables.
68
+ The [.env file](/docs/config/dotenv.html)
69
+ is a great place to store your API keys and other provider API environment variables:
70
+
71
+ ```bash
72
+ GEMINI_API_KEY=foo
73
+ OPENROUTER_API_KEY=bar
74
+ DEEPSEEK_API_KEY=baz
75
+ ```
76
+
77
+ #### YAML config file
78
+
79
+
80
+ You can also set API keys in the
81
+ [`.aider.conf.yml` file](/docs/config/aider_conf.html)
82
+ via the `api-key` entry:
83
+
84
+ ```
85
+ api-key:
86
+ - gemini=foo # Sets env var GEMINI_API_KEY=foo
87
+ - openrouter=bar # Sets env var OPENROUTER_API_KEY=bar
88
+ - deepseek=baz # Sets env var DEEPSEEK_API_KEY=baz
89
+ ```
90
+