cecli-dev 0.93.1__py3-none-any.whl

cecli/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.
+

cecli/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.
+
+

cecli/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>
+
+

cecli/website/docs/usage/copypaste.md

@@ -0,0 +1,136 @@
+---
+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`.
+
+### No API access? Use `cp:model`
+
+If your only access to an LLM is via a web chat (no API keys, no local models), you can run aider with a model name prefixed by cp:. This performs the entire workflow via copy/paste without making any API calls.
+
+#### What cp: does
+
+- Activates CopyPasteCoder, which never sends requests to any LLM API.
+- Uses the same copy/paste workflow described above
+
+#### Token and cost tracking
+
+- Aider uses the text after cp: as the "model name" for local token counting and cost estimation.
+- If the label matches a known model in aider's pricing tables, aider will estimate tokens/costs using that model's rates; otherwise, costs may show as unknown or zero.
+- With flat-rate web chat plans, you can treat any "estimated cost" displayed by aider as your "savings" versus if you had called an API model.
+
+## 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.

cecli/website/docs/usage/images-urls.md

@@ -0,0 +1,48 @@
+---
+parent: Usage
+nav_order: 700
+description: Add images and web pages to the aider coding chat.
+---
+
+# Images & web pages
+
+You can add images and URLs to the aider chat.
+
+## Images
+
+Aider supports working with image files for many vision-capable models
+like GPT-4o and Claude 3.7 Sonnet.
+Adding images to a chat can be helpful in many situations:
+
+- Add screenshots of web pages or UIs that you want aider to build or modify.
+- Show aider a mockup of a UI you want to build.
+- Screenshot an error message that is otherwise hard to copy & paste as text.
+- Etc.
+
+You can add images to the chat just like you would
+add any other file:
+
+- Use `/add <image-filename>` from within the chat
+- Use `/paste` to paste an image from your clipboard into the chat.
+- Launch aider with image filenames on the command line: `aider <image-filename>` along with any other command line arguments you need.
+
+## Web pages
+
+Aider can scrape the text from URLs and add it to the chat.
+This can be helpful to:
+
+- Include documentation pages for less popular APIs.
+- Include the latest docs for libraries or packages that are newer than the model's training cutoff date.
+- Etc.
+
+To add URLs to the chat:
+
+- Use `/web <url>`
+- Just paste the URL into the chat and aider will ask if you want to add it.
+
+You can also scrape web pages from the command line to see the markdown version that aider produces:
+
+
+```
+python -m aider.scrape https://aider.chat/docs/usage/tips.html
+```

cecli/website/docs/usage/lint-test.md

@@ -0,0 +1,118 @@
+---
+parent: Usage
+nav_order: 900
+description: Automatically fix linting and testing errors.
+---
+
+# Linting and testing
+
+Aider can automatically lint and test your code
+every time it makes changes.
+This helps identify and repair any problems introduced
+by the AI edits.
+
+## Linting
+
+Aider comes with built in linters for 
+[most popular languages](/docs/languages.html)
+and will automatically lint code in these languages.
+
+Or you can specify your favorite linter
+with the `--lint-cmd <cmd>` switch.
+The lint command should accept the filenames
+of the files to lint. 
+If there are linting errors, aider expects the
+command to print them on stdout/stderr
+and return a non-zero exit code.
+This is how most linters normally operate.
+
+By default, aider will lint any files which it edits.
+You can disable this with the `--no-auto-lint` switch.
+
+### Per-language linters
+
+To specify different linters based on the code language, use `--lint "language: cmd"`.
+
+### Code formatting "linters"
+
+Many people use code formatters as linters, to format and pretty their code.
+These tools sometimes return non-zero exit codes if they make changes, which will
+confuse aider into thinking there's an actual lint error that needs to be fixed.
+
+You can use formatters by wrapping them in a shell script like this and setting
+the script as your linter.
+
+```bash
+#!/bin/bash
+
+# Run it twice.
+#
+# First attempt may reformat/modify files, and therefore exit with non-zero status.
+#
+# Second attempt will not do anything and exit 0 unless there's a real problem beyond
+# the code formatting that was completed.
+
+pre-commit run --files "$@" >/dev/null \
+    || pre-commit run --files "$@"
+```
+
+## Testing
+
+You can run tests with `/test <test-command>`.
+Aider will run the test command without any arguments.
+If there are test errors, aider expects the
+command to print them on stdout/stderr
+and return a non-zero exit code.
+
+Aider will try and fix any errors
+if the command returns a non-zero exit code.
+
+You can configure aider to run your test suite
+after each time the AI edits your code
+using the `--test-cmd <test-command>` and
+`--auto-test` switch.
+
+
+
+## Compiled languages
+
+If you want to have aider compile code after each edit, you
+can use the lint and test commands to achieve this.
+
+- You might want to recompile each file which was modified
+to check for compile errors.
+To do this,
+provide a `--lint-cmd` which both lints and compiles the file.
+You could create a small shell script for this.
+- You might want to rebuild the entire project after files
+are edited to check for build errors.
+To do this,
+provide a `--test-cmd` which both builds and tests the project.
+You could create a small shell script for this.
+Or you may be able to do something as simple as
+`--test-cmd "dotnet build && dotnet test"`.
+
+## Manually running code
+
+You can use the `/run` command in the chat to run your code
+and optionally share the output with aider.
+This can be useful to share error messages or to show aider
+the code's output before asking for changes or corrections.
+
+<div class="chat-transcript" markdown="1">
+> Aider v0.43.5-dev  
+
+#### /run python myscript.py
+
+```
+Traceback (most recent call last):  
+ File "myscript.py", line 22, in \<module\ 
+   raise ValueError("something bad happened")  
+ValueError: something bad happened  
+```
+
+> Add the output to the chat? y  
+
+</div>
+
+