aider-ce 0.88.20__py3-none-any.whl

aider/website/docs/troubleshooting/edit-errors.md

@@ -0,0 +1,76 @@
+---
+parent: Troubleshooting
+nav_order: 10
+---
+
+# File editing problems
+
+Sometimes the LLM will reply with some code changes
+that don't get applied to your local files.
+In these cases, aider might say something like "Failed to apply edit to *filename*"
+or other error messages.
+
+This usually happens because the LLM is disobeying the system prompts
+and trying to make edits in a format that aider doesn't expect.
+Aider makes every effort to get the LLM
+to conform, and works hard to deal with
+LLM edits that are "almost" correctly formatted.
+
+But sometimes the LLM just won't cooperate.
+In these cases, here are some things you might try.
+
+## Don't add too many files
+
+Many LLMs now have very large context windows,
+but filling them with irrelevant code or conversation 
+can confuse the model.
+Above about 25k tokens of context, most models start to become distracted and become less likely
+to conform to their system prompt.
+
+- Don't add too many files to the chat, *just* add the files you think need to be edited.
+Aider also sends the LLM a [map of your entire git repo](https://aider.chat/docs/repomap.html), so other relevant code will be included automatically.
+- Use `/drop` to remove files from the chat session which aren't needed for the task at hand. This will reduce distractions and may help the LLM produce properly formatted edits.
+- Use `/clear` to remove the conversation history, again to help the LLM focus.
+- Use `/tokens` to see how many tokens you are using for each message.
+
+## Use a more capable model
+
+If possible try using GPT-4o, o3-mini, Claude 3.7 Sonnet, DeepSeek V3 or DeepSeek R1.
+They are the strong and capable models.
+
+Weaker models
+are more prone to
+disobeying the system prompt instructions.
+Most local models are just barely capable of working with aider,
+so editing errors are probably unavoidable.
+
+## Local models: context window and quantization
+
+Be especially careful about the
+[Ollama context window](https://aider.chat/docs/llms/ollama.html#setting-the-context-window-size)
+when working with local models.
+It defaults to be very small and silently discards data if you exceed it.
+
+Local models which have been quantized are more likely to have editing problems
+because they are not capable enough to follow aider's system prompts.
+
+## Try the whole edit format
+
+Run aider with `--edit-format whole` if were using a different edit format.
+You can see which edit format it is using in the announce lines:
+
+```
+Aider v0.50.2-dev
+Models: claude-3-5-sonnet-20240620 with ♾️ diff edit format
+```
+
+## Try architect mode
+
+Run aider with `--architect` or `/chat-mode architect` to enable [architect mode](../usage/modes.md#architect-mode-and-the-editor-model).
+This mode first proposes changes, then uses a separate model to handle the file edits.
+This two-step process often produces more reliable edits, especially with models that have trouble
+following edit format instructions.
+
+## More help
+
+{% include help.md %}

aider/website/docs/troubleshooting/imports.md

@@ -0,0 +1,62 @@
+---
+parent: Troubleshooting
+nav_order: 28
+---
+
+# Dependency versions
+
+Aider expects to be installed with the
+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.
+
+
+## Avoid package conflicts
+
+If you are using aider to work on a python project, sometimes your project will require
+specific versions of python packages which conflict with the versions that aider
+requires.
+If this happens, you may see errors like these when running pip installs:
+
+```
+aider-chat 0.23.0 requires somepackage==X.Y.Z, but you have somepackage U.W.V which is incompatible.
+```
+
+## Install with aider-install, uv or pipx
+
+If you are having dependency problems you should consider
+[installing aider using aider-install, uv or pipx](/docs/install.html).
+This will ensure that aider is installed in its own python environment,
+with the correct set of dependencies.
+
+## Package managers like Homebrew, AUR, ports
+
+Package managers often install aider with the wrong dependencies, leading
+to import errors and other problems.
+
+It is recommended to
+[install aider using aider-install, uv or pipx](/docs/install.html).
+
+
+## Dependency versions matter
+
+Aider pins its dependencies and is tested to work with those specific versions.
+If you are installing aider directly with pip
+you should be careful about upgrading or downgrading the python packages that
+aider uses.
+
+In particular, be careful with the packages with pinned versions 
+noted at the end of
+[aider's requirements.in file](https://github.com/Aider-AI/aider/blob/main/requirements/requirements.in).
+These versions are pinned because aider is known not to work with the
+latest versions of these libraries.
+
+Also be wary of upgrading `litellm`, as it changes versions frequently
+and sometimes introduces bugs or backwards incompatible changes.
+
+## Replit
+
+{% include replit-pipx.md %}

aider/website/docs/troubleshooting/models-and-keys.md

@@ -0,0 +1,54 @@
+---
+parent: Troubleshooting
+nav_order: 28
+---
+
+# Models and API keys
+
+Aider needs to know which LLM model you would like to work with and which keys
+to provide when accessing it via API.
+
+## Defaults
+
+If you don't explicitly name a model, aider will try to select a model
+for you to work with.
+
+First, aider will check which 
+[keys you have provided via the environment, config files, or command line arguments](https://aider.chat/docs/config/api-keys.html).
+Based on the available keys, aider will select the best model to use.
+
+## OpenRouter
+
+If you have not provided any keys, aider will offer to help you connect to 
+[OpenRouter](http://openrouter.ai)
+which provides both free and paid access to most popular LLMs.
+Once connected, aider will select the best model available on OpenRouter
+based on whether you have a free or paid account there.
+
+## Specifying model & key
+
+You can also tell aider which LLM to use and provide an API key.
+The easiest way is to use the `--model` and `--api-key`
+command line arguments, like this:
+
+```
+# Work with DeepSeek via DeepSeek's API
+aider --model deepseek --api-key deepseek=your-key-goes-here
+
+# Work with Claude 3.7 Sonnet via Anthropic's API
+aider --model sonnet --api-key anthropic=your-key-goes-here
+
+# Work with o3-mini via OpenAI's API
+aider --model o3-mini --api-key openai=your-key-goes-here
+
+# Work with Sonnet via OpenRouter's API
+aider --model openrouter/anthropic/claude-3.7-sonnet --api-key openrouter=your-key-goes-here
+
+# Work with DeepSeek Chat V3 via OpenRouter's API
+aider --model openrouter/deepseek/deepseek-chat --api-key openrouter=your-key-goes-here
+```
+
+For more information, see the documentation sections:
+
+- [Connecting to LLMs](https://aider.chat/docs/llms.html)
+- [Configuring API keys](https://aider.chat/docs/config/api-keys.html)

aider/website/docs/troubleshooting/support.md

@@ -0,0 +1,79 @@
+---
+parent: Troubleshooting
+excerpt: Use "/help <question>" to ask for help about using aider, customizing settings, troubleshooting, using LLMs, etc.
+nav_order: 30
+---
+
+# Using /help
+
+Type `/help <question>` and
+aider will respond with helpful information.
+You can ask questions about using aider, 
+customizing settings, troubleshooting, using LLMs, etc.
+
+Behind the scenes, aider has indexed all of its
+[documentation](https://aider.chat/).
+It uses the question to find relevant docs
+and share them with the LLM to do
+retrieval augmented generation (RAG)
+The LLM also has the full context of your ongoing
+aider chat,
+so it can help with the exact issue you might be facing.
+
+
+<div class="chat-transcript" markdown="1">
+
+> Aider v0.42.1-dev  
+> Models: claude-3-5-sonnet with diff edit format  
+> Repo-map: using 1024 tokens  
+> Use /help \<question\> to ask for help, run with --help to see cmd line args  
+
+#### /help is the .env file global or for a git repo?
+
+Based on the provided documentation, here's the answer to your question about the .env file in aider:
+
+The .env file in aider can be both global and specific to a git repository. Aider looks for .env files in multiple locations, with the following priority order:
+
+1. Your home directory (global)
+2. The root of your git repo (repo-specific)
+3. The current directory
+4. A file specified with the `--env-file <filename>` parameter
+
+If multiple .env files exist in these locations, they are loaded in the order listed above, with files loaded last taking priority. This means you can have a global .env file in your home directory with general settings, and then override or add to those settings with a repo-specific .env file in your git repository root.
+
+Here are some relevant documentation links that you might find helpful:
+
+- https://aider.chat/docs/config.html
+- https://aider.chat/docs/config/dotenv.html
+
+The ability to use both global and repo-specific .env files allows for flexible configuration, where you can set default values globally and override them on a per-project basis as needed.
+
+</div>
+<div class="chat-transcript" markdown="1">
+
+#### /help can i use local LLMs?
+
+Yes, you can use local LLMs with Aider. Here's a summary of the options:
+
+1. Ollama: Aider supports using local models through Ollama.
+
+2. OpenAI-compatible API: Aider can access local models that provide an OpenAI-compatible API.
+
+3. Other local models: Aider uses the LiteLLM package to connect to various LLM providers, which may include options for running models locally.
+
+However, it's important to note that Aider works best with more capable models. Less capable models may have difficulty properly returning "code edits," which could result in Aider not being able to edit your files and commit changes effectively.
+
+For more detailed information on using local LLMs and connecting to various models, you might want to check out these relevant documentation pages:
+
+- https://aider.chat/docs/llms.html
+- https://aider.chat/docs/llms/ollama.html
+- https://aider.chat/docs/llms/openai-compat.html
+
+Keep in mind that the performance and capabilities of local LLMs may vary depending on the specific model and your hardware resources.
+
+</div>
+
+
+## Getting more help
+
+{% include help.md %}

aider/website/docs/troubleshooting/token-limits.md

@@ -0,0 +1,96 @@
+---
+parent: Troubleshooting
+nav_order: 25
+---
+
+# Token limits
+
+Every LLM has limits on how many tokens it can process for each request:
+
+- The model's **context window** limits how many total tokens of
+*input and output* it can process.
+- Each model has limit on how many **output tokens** it can
+produce.
+
+Aider will report an error **if a model responds** indicating that
+it has exceeded a token limit.
+The error will include suggested actions to try and
+avoid hitting token limits.
+
+Here's an example error: 
+
+```
+Model gpt-3.5-turbo has hit a token limit!
+
+Input tokens: 768 of 16385
+Output tokens: 4096 of 4096 -- exceeded output limit!
+Total tokens: 4864 of 16385
+
+To reduce output tokens:
+- Ask for smaller changes in each request.
+- Break your code into smaller source files.
+- Try using a stronger model like DeepSeek V3 or Sonnet that can return diffs.
+
+For more info: https://aider.chat/docs/token-limits.html
+```
+
+{: .note }
+Aider never *enforces* token limits, it only *reports* token limit errors
+from the API provider.
+The token counts that aider reports are *estimates*.
+
+## Input tokens & context window size
+
+The most common problem is trying to send too much data to a 
+model,
+overflowing its context window.
+Technically you can exhaust the context window if the input is
+too large or if the input plus output are too large.
+
+Strong models like GPT-4o and Sonnet have quite
+large context windows, so this sort of error is
+typically only an issue when working with weaker models.
+
+The easiest solution is to try and reduce the input tokens
+by removing files from the chat.
+It's best to only add the files that aider will need to *edit*
+to complete your request.
+
+- Use `/tokens` to see token usage.
+- Use `/drop` to remove unneeded files from the chat session.
+- Use `/clear` to clear the chat history.
+- Break your code into smaller source files.
+
+## Output token limits
+
+Most models have quite small output limits, often as low
+as 4k tokens.
+If you ask aider to make a large change that affects a lot
+of code, the LLM may hit output token limits
+as it tries to send back all the changes.
+
+To avoid hitting output token limits:
+
+- Ask for smaller changes in each request.
+- Break your code into smaller source files.
+- Use a strong model like gpt-4o, sonnet or DeepSeek V3 that can return diffs.
+- Use a model that supports [infinite output](/docs/more/infinite-output.html).
+
+## Other causes
+
+Sometimes token limit errors are caused by 
+non-compliant API proxy servers
+or bugs in the API server you are using to host a local model.
+Aider has been well tested when directly connecting to 
+major 
+[LLM provider cloud APIs](https://aider.chat/docs/llms.html).
+For serving local models, 
+[Ollama](https://aider.chat/docs/llms/ollama.html) is known to work well with aider.
+
+Try using aider without an API proxy server
+or directly with one of the recommended cloud APIs
+and see if your token limit problems resolve.
+
+## More help
+
+{% include help.md %}

aider/website/docs/troubleshooting/warnings.md

@@ -0,0 +1,12 @@
+---
+parent: Troubleshooting
+nav_order: 20
+---
+
+# Model warnings
+
+{% include model-warnings.md %}
+
+## More help
+
+{% include help.md %}

aider/website/docs/troubleshooting.md

@@ -0,0 +1,11 @@
+---
+nav_order: 60
+has_children: true
+description: How to troubleshoot problems with aider and get help.
+---
+
+# Troubleshooting
+
+Below are some approaches for troubleshooting problems with aider.
+
+{% include help.md %}

aider/website/docs/usage/browser.md

@@ -0,0 +1,57 @@
+---
+title: Aider in your browser
+highlight_image: /assets/browser.jpg
+parent: Usage
+nav_order: 800
+description: Aider can run in your browser, not just on the command line.
+---
+{% if page.date %}
+<p class="post-date">{{ page.date | date: "%B %d, %Y" }}</p>
+{% endif %}
+
+# Aider in your browser
+
+<div class="video-container">
+  <video controls loop poster="/assets/browser.jpg">
+    <source src="/assets/aider-browser-social.mp4" type="video/mp4">
+    <a href="/assets/aider-browser-social.mp4">Aider browser UI demo video</a>
+  </video>
+</div>
+
+<style>
+.video-container {
+  position: relative;
+  padding-bottom: 101.89%; /* 1080 / 1060 = 1.0189 */
+  height: 0;
+  overflow: hidden;
+}
+
+.video-container video {
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+}
+</style>
+
+Use aider's new experimental browser UI to collaborate with LLMs
+to edit code in your local git repo.
+Aider will directly edit the code in your local source files,
+and [git commit the changes](https://aider.chat/docs/git.html)
+with sensible commit messages.
+You can start a new project or work with an existing git repo.
+Aider works well with 
+GPT-4o, Sonnet 3.7, and DeepSeek Chat V3 & R1.
+It also supports [connecting to almost any LLM](https://aider.chat/docs/llms.html).
+
+Use the `--browser` switch to launch the browser version of aider:
+
+```
+python -m pip install -U aider-chat
+
+export OPENAI_API_KEY=<key> # Mac/Linux
+setx   OPENAI_API_KEY <key> # Windows, restart shell after setx
+
+aider --browser
+```

aider/website/docs/usage/caching.md

@@ -0,0 +1,49 @@
+---
+title: Prompt caching
+highlight_image: /assets/prompt-caching.jpg
+parent: Usage
+nav_order: 750
+description: Aider supports prompt caching for cost savings and faster coding.
+---
+
+# Prompt caching
+
+Aider supports prompt caching for cost savings and faster coding.
+Currently Anthropic provides caching for Sonnet and Haiku,
+and DeepSeek provides caching for Chat.
+
+Aider organizes the chat history to try and cache:
+
+- The system prompt.
+- Read only files added with `--read` or `/read-only`.
+- The repository map.
+- The editable files that have been added to the chat.
+
+![Prompt caching](/assets/prompt-caching.jpg)
+
+
+## Usage
+
+Run aider with `--cache-prompts` or add that setting to your 
+[configuration files](/docs/config.html).
+
+Due to limitations in the provider APIs, caching statistics and costs
+are not available when streaming responses.
+To turn off streaming, use `--no-stream`.
+
+When caching is enabled, it will be noted for the main model when aider launches:
+
+```
+Main model: claude-3-5-sonnet-20240620 with diff edit format, prompt cache, infinite output
+```
+
+## Preventing cache expiration
+
+Aider can ping the provider to keep your prompt cache warm and prevent
+it from expiring.
+By default, Anthropic keeps your cache for 5 minutes.
+Use `--cache-keepalive-pings N` to tell aider to ping
+every 5 minutes to keep the cache warm.
+Aider will ping up to `N` times over a period of `N*5` minutes
+after each message you send.
+

aider/website/docs/usage/commands.md

@@ -0,0 +1,133 @@
+---
+parent: Usage
+nav_order: 50
+description: Control aider with in-chat commands like /add, /model, etc.
+---
+
+# In-chat commands
+{: .no_toc }
+
+- TOC
+{:toc}
+
+## Slash commands
+
+Aider supports commands from within the chat, which all start with `/`.
+
+<!--[[[cog
+from aider.commands import get_help_md
+cog.out(get_help_md())
+]]]-->
+
+|Command|Description|
+|:------|:----------|
+| **/add** | Add files to the chat so aider can edit them or review them in detail |
+| **/architect** | Enter architect/editor mode using 2 different models. If no prompt provided, switches to architect/editor mode. |
+| **/ask** | Ask questions about the code base without editing any files. If no prompt provided, switches to ask mode. |
+| **/chat-mode** | Switch to a new chat mode |
+| **/clear** | Clear the chat history |
+| **/code** | Ask for changes to your code. If no prompt provided, switches to code mode. |
+| **/commit** | Commit edits to the repo made outside the chat (commit message optional) |
+| **/context** | Enter context mode to see surrounding code context. If no prompt provided, switches to context mode. |
+| **/copy** | Copy the last assistant message to the clipboard |
+| **/copy-context** | Copy the current chat context as markdown, suitable to paste into a web UI |
+| **/diff** | Display the diff of changes since the last message |
+| **/drop** | Remove files from the chat session to free up context space |
+| **/edit** | Alias for /editor: Open an editor to write a prompt |
+| **/editor** | Open an editor to write a prompt |
+| **/editor-model** | Switch the Editor Model to a new LLM |
+| **/exit** | Exit the application |
+| **/git** | Run a git command (output excluded from chat) |
+| **/help** | Ask questions about aider |
+| **/history-search** | Fuzzy search your command history and paste the selected command into the chat. |
+| **/lint** | Lint and fix in-chat files or all dirty files if none in chat |
+| **/load** | Load and execute commands from a file |
+| **/ls** | List all known files and indicate which are included in the chat session |
+| **/map** | Print out the current repository map |
+| **/map-refresh** | Force a refresh of the repository map |
+| **/model** | Switch the Main Model to a new LLM |
+| **/models** | Search the list of available models |
+| **/multiline-mode** | Toggle multiline mode (swaps behavior of Enter and Meta+Enter) |
+| **/paste** | Paste image/text from the clipboard into the chat.        Optionally provide a name for the image. |
+| **/quit** | Exit the application |
+| **/read-only** | Add files to the chat that are for reference only, or turn added files to read-only |
+| **/reasoning-effort** | Set the reasoning effort level (values: number or low/medium/high depending on model) |
+| **/report** | Report a problem by opening a GitHub Issue |
+| **/reset** | Drop all files and clear the chat history |
+| **/run** | Run a shell command and optionally add the output to the chat (alias: !) |
+| **/save** | Save commands to a file that can reconstruct the current chat session's files |
+| **/settings** | Print out the current settings |
+| **/test** | Run a shell command and add the output to the chat on non-zero exit code |
+| **/think-tokens** | Set the thinking token budget, eg: 8096, 8k, 10.5k, 0.5M, or 0 to disable. |
+| **/tokens** | Report on the number of tokens used by the current chat context |
+| **/undo** | Undo the last git commit if it was done by aider |
+| **/voice** | Record and transcribe voice input |
+| **/weak-model** | Switch the Weak Model to a new LLM |
+| **/web** | Scrape a webpage, convert to markdown and send in a message |
+
+<!--[[[end]]]-->
+
+{: .tip }
+You can easily re-send commands or messages.
+Use the up arrow ⬆ to scroll back
+or CONTROL-R to search your message history.
+
+## Entering multi-line chat messages
+
+{% include multi-line.md %}
+
+## Interrupting with CONTROL-C
+
+It's always safe to use Control-C to interrupt aider if it isn't providing a useful response. The partial response remains in the conversation, so you can refer to it when you reply to the LLM with more information or direction.
+
+## Keybindings
+
+The interactive prompt is built with [prompt-toolkit](https://github.com/prompt-toolkit/python-prompt-toolkit) which provides emacs and vi keybindings. 
+
+### Emacs
+
+- `Up Arrow` : Move up one line in the current message.
+- `Down Arrow` : Move down one line in the current message.
+- `Ctrl-Up` : Scroll back through previously sent messages.
+- `Ctrl-Down` : Scroll forward through previously sent messages.
+- `Ctrl-A` : Move cursor to the start of the line.
+- `Ctrl-B` : Move cursor back one character.
+- `Ctrl-D` : Delete the character under the cursor.
+- `Ctrl-E` : Move cursor to the end of the line.
+- `Ctrl-F` : Move cursor forward one character.
+- `Ctrl-K` : Delete from the cursor to the end of the line.
+- `Ctrl-L` : Clear the screen.
+- `Ctrl-N` : Move down to the next history entry.
+- `Ctrl-P` : Move up to the previous history entry.
+- `Ctrl-R` : Reverse search in command history.
+- `Ctrl-X Ctrl-E` : Open the current input in an external editor
+- `Ctrl-Y` : Paste (yank) text that was previously cut.
+
+
+### Vi
+
+To use vi/vim keybindings, run aider with the `--vim` switch.
+
+- `Up Arrow` : Move up one line in the current message.
+- `Down Arrow` : Move down one line in the current message.
+- `Ctrl-Up` : Scroll back through previously sent messages.
+- `Ctrl-Down` : Scroll forward through previously sent messages.
+- `Esc` : Switch to command mode.
+- `i` : Switch to insert mode.
+- `a` : Move cursor one character to the right and switch to insert mode.
+- `A` : Move cursor to the end of the line and switch to insert mode.
+- `I` : Move cursor to the beginning of the line and switch to insert mode.
+- `h` : Move cursor one character to the left.
+- `j` : Move cursor down one line.
+- `k` : Move cursor up one line.
+- `l` : Move cursor one character to the right.
+- `w` : Move cursor forward one word.
+- `b` : Move cursor backward one word.
+- `0` : Move cursor to the beginning of the line.
+- `$` : Move cursor to the end of the line.
+- `x` : Delete the character under the cursor.
+- `dd` : Delete the current line.
+- `u` : Undo the last change.
+- `Ctrl-R` : Redo the last undone change.
+
+