chatmcp-cli 0.1.0__py3-none-any.whl

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,132 @@
+---
+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 |
+| **/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 (supports formats like 8096, 8k, 10.5k, 0.5M) |
+| **/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.
+
+

aider/website/docs/usage/conventions.md

@@ -0,0 +1,119 @@
+---
+parent: Usage
+nav_order: 800
+description: Tell aider to follow your coding conventions when it works on your code.
+---
+# Specifying coding conventions
+
+Sometimes you want GPT to be aware of certain coding guidelines,
+like whether to provide type hints, which libraries or packages
+to prefer, etc.
+
+The easiest way to do that with aider is to simply create
+a small markdown file and include it in the chat.
+
+For example, say we want our python code to:
+
+```
+- Prefer httpx over requests for making http requests.
+- Use types everywhere possible.
+```
+
+We would simply create a file like `CONVENTIONS.md` with those lines
+and then we can add it to the aider chat, along with the file(s)
+that we want to edit.
+
+It's best to load the conventions file with `/read CONVENTIONS.md` 
+or `aider --read CONVENTIONS.md`. 
+This way it is marked as read-only, and cached if prompt caching
+is enabled.
+
+## Community contributed conventions
+
+You can check the [aider conventions repository](https://github.com/Aider-AI/conventions)
+to find or contribute conventions files.
+
+## Always load conventions
+
+You can also configure aider to always load your conventions file
+in the [`.aider.conf.yml` config file](https://aider.chat/docs/config/aider_conf.html):
+
+
+```yaml
+# alone
+read: CONVENTIONS.md
+
+# multiple files
+read: [CONVENTIONS.md, anotherfile.txt]
+```
+
+
+## Example
+
+See below for an example of how the conventions can affect the code
+that aider writes.
+
+<div class="chat-transcript" markdown="1">
+> $ aider --read CONVENTIONS.md useragent.py  
+>  
+> Aider v0.24.2-dev  
+> Added CONVENTIONS.md to the chat.  
+> Added useragent.py to the chat.  
+
+#### write a function that uses httpbin to check the user agent on the request. return the ua.  
+
+To fulfill your request, I will:
+
+1. Add an import for `httpx`.
+2. Write a function named `check_user_agent` that makes a GET request to `httpbin.org/user-agent` and returns the user agent string.
+
+Here is the diff for the `useragent.py` file:
+
+```diff
+--- useragent.py
++++ useragent.py
+@@ ... @@
++import httpx
++
++def check_user_agent() -> str:
++    response = httpx.get('https://httpbin.org/user-agent')
++    return response.json()['user-agent']
+```
+
+This function uses `httpx` to make a GET request to `httpbin.org/user-agent`, which returns a JSON response containing the user agent of the HTTP client. The function then extracts the user agent string from the JSON response and returns it.
+
+> Applied edit to useragent.py  
+</div>
+
+GPT correctly used `httpx` and provided type hints.
+See below for the transcript of this same
+coding task conducted *without*
+using `CONVENTIONS.md`.
+In this case, GPT used `requests` and skipped types,
+which is perhaps more typical in small python scripts.
+
+<div class="chat-transcript" markdown="1">
+> $ aider useragent.py  
+>  
+> Aider v0.24.2-dev  
+> Added useragent.py to the chat.  
+
+
+#### write a function that uses httpbin to check the user agent on the request. return the ua.  
+
+```diff
+--- /dev/null
++++ useragent.py
+@@ ... @@
++import requests
++
++def check_user_agent():
++    response = requests.get('https://httpbin.org/user-agent')
++    user_agent = response.json().get('user-agent')
++    return user_agent
+```
+
+> Applied edit to useragent.py  
+</div>
+
+

aider/website/docs/usage/copypaste.md

@@ -0,0 +1,121 @@
+---
+title: Copy/paste with web chat
+#highlight_image: /assets/browser.jpg
+parent: Usage
+nav_order: 850
+description: Aider works with LLM web chat UIs
+---
+
+# Copy/paste with web chat
+
+<div class="video-container">
+  <video controls loop poster="/assets/copypaste.jpg">
+    <source src="/assets/copypaste.mp4" type="video/mp4">
+    <a href="/assets/copypaste.mp4">Aider browser UI demo video</a>
+  </video>
+</div>
+
+<style>
+.video-container {
+  position: relative;
+  padding-bottom: 66.34%; /* 2160 / 3256 = 0.6634 */
+  height: 0;
+  overflow: hidden;
+}
+
+.video-container video {
+  position: absolute;
+  top: 0;
+  left: 0;
+  width: 100%;
+  height: 100%;
+}
+</style>
+
+## Working with an LLM web chat
+
+[Aider can connect to most LLMs via API](https://aider.chat/docs/llms.html) and works best that way.
+But there are times when you may want to work with an LLM via its web chat interface:
+
+- Workplace policies may limit your LLM usage to a proprietary web chat system.
+- The web chat LLM may have access to unique context or may have been specially fine tuned for your task.
+- It may be cost prohibitive to use some models via API.
+- There may not be an API available.
+
+Aider has features for working with an LLM via its web chat interface.
+This allows you to use the web chat LLM as the "big brain code architect"
+while running aider with a smaller, cheaper LLM to actually make changes
+to your local files.
+
+For this "file editor" part of the process 
+you can run aider with many open source, free or very inexpensive LLMs.
+For example, the demo video above shows aider using DeepSeek to apply the changes
+that o1-preview is suggesting in the web chat.
+
+### Copy aider's code context to your clipboard, paste into the web UI
+
+The `/copy-context <instructions>` command can be used in chat to copy aider's code context to your clipboard.
+It will include:
+
+- All the files which have been added to the chat via `/add`.
+- Any read only files which have been added via `/read`.
+- Aider's [repository map](https://aider.chat/docs/repomap.html) that brings in code context related to the above files from elsewhere in your git repo.
+- Some instructions to the LLM that ask it to output change instructions concisely.
+- If you include `<instructions>`, they will be copied too.
+
+You can paste the context into your browser, and start interacting with the LLM web chat to
+ask for code changes.
+
+### Paste the LLM's reply back into aider to edit your files
+
+Once the LLM has replied, you can use the "copy response" button in the web UI to copy
+the LLM's response.
+Back in aider, you can run `/paste` and aider will edit your files
+to implement the changes suggested by the LLM.
+
+You can use a cheap, efficient model like GPT-4o Mini, DeepSeek or Qwen to do these edits.
+This works best if you run aider with `--edit-format editor-diff` or `--edit-format editor-whole`.
+
+### Copy/paste mode
+
+Aider has a `--copy-paste` mode that streamlines this entire process:
+
+- Whenever you `/add` or `/read` files, aider will automatically copy the entire, updated
+code context to your clipboard. 
+You'll see "Copied code context to clipboard" whenever this happens.
+- When you copy the LLM reply to your clipboard outside aider, aider will automatically notice
+and load it into the aider chat. 
+Just press ENTER to send the message
+and aider will apply the LLMs changes to your local files.
+- Aider will automatically select the best edit format for this copy/paste functionality. 
+Depending on the LLM you have aider use, it will be either `editor-whole` or `editor-diff`.
+
+## Terms of service
+
+Be sure to review the Terms Of Service of any LLM web chat service you use with
+these features.
+These features are not intended to be used in violation of any service's Terms Of Service (TOS).
+
+Aider's web chat features have been designed to be compliant with the 
+terms of service of most LLM web chats.
+
+There are 4 copy/paste steps involved when coding with an LLM web chat:
+
+1. Copy code and context from aider.
+2. Paste the code and context into the LLM web chat.
+3. Copy the reply from the LLM web chat.
+4. Paste the LLM reply into aider.
+
+Most LLM web chat TOS prohibit automating steps (2) and (3) where code
+is copied from and pasted into the web chat.
+Aider's `--copy-paste` mode leaves those as 100% manual steps for the user to complete.
+It simply streamlines steps (1) and (4) that are interactions with aider,
+and which should not be under the scope of an LLM web chat TOS.
+
+If you are concerned that
+the automatic interactions with aider in steps (1) and (4) may be problematic with respect to
+your LLM web chat provider's TOS, you can forego `--copy-paste` mode.
+Instead, manually use the `/copy-context` and `/paste` commands if that
+will keep you in compliance.
+
+Again, do not use these features in violation of any service's Terms Of Service.