cecli-dev 0.95.5__py3-none-any.whl

cecli/website/docs/faq.md

@@ -0,0 +1,379 @@
+---
+nav_order: 90
+description: Frequently asked questions about aider.
+---
+
+# FAQ
+{: .no_toc }
+
+- TOC
+{:toc}
+
+{% include help-tip.md %}
+
+## How can I add ALL the files to the chat?
+
+People regularly ask about how to add **many or all of their repo's files** to the chat.
+This is probably not a good idea and will likely do more harm than good.
+
+The best approach is think about which files need to be changed to accomplish
+the task you are working on. Just add those files to the chat.
+
+Usually when people want to add "all the files" it's because they think it
+will give the LLM helpful context about the overall code base.
+Aider will automatically give the LLM a bunch of additional context about
+the rest of your git repo.
+It does this by analyzing your entire codebase in light of the
+current chat to build a compact
+[repository map](https://aider.chat/2023/10/22/repomap.html).
+
+Adding a bunch of files that are mostly irrelevant to the
+task at hand will often distract or confuse the LLM.
+The LLM will give worse coding results, and sometimese even fail to correctly edit files.
+Addings extra files will also increase your token costs.
+
+Again, it's usually best to just add the files to the chat that will need to be modified.
+If you still wish to add lots of files to the chat, you can:
+
+- Use a wildcard when you launch aider: `aider src/*.py`
+- Use a wildcard with the in-chat `/add` command: `/add src/*.py`
+- Give the `/add` command a directory name and it will recursively add every file under that dir: `/add src`
+
+## Can I use aider in a large (mono) repo?
+
+Aider will work in any size repo, but is not optimized for quick
+performance and response time in very large repos.
+There are some things you can do to improve performance.
+
+Be sure to check the
+[general usage tips](/docs/usage/tips.html)
+before considering this large-repo specific advice.
+To get the best results from aider you want to 
+be thoughtful about how you add files to the chat,
+regardless of your repo size.
+
+You can change into a sub directory of your repo that contains the
+code you want to work on and use the `--subtree-only` switch.
+This will tell aider to ignore the repo outside of the
+directory you start in.
+
+You can also create a `.aiderignore` file to tell aider
+to ignore parts of the repo that aren't relevant to your task.
+This file conforms to `.gitignore` syntax and conventions.
+For example, to focus only on specific directories in a monorepo,
+you could create a `.aiderignore` file with:
+
+```
+# Ignore everything
+/*
+
+# Allow specific directories and their contents
+!foo/
+!bar/
+!baz/
+
+# Allow nested files under these directories
+!foo/**
+!bar/**
+!baz/**
+```
+
+You can use `--aiderignore <filename>` to name a specific file
+to use for ignore patterns.
+You might have a few of these handy for when you want to work on
+frontend, backend, etc portions of your repo.
+
+## Can I use aider with multiple git repos at once?
+
+Currently aider can only work with one repo at a time.
+
+There are some things you can try if you need to work with
+multiple interrelated repos:
+
+- You can run aider in repo-A where you need to make a change
+and use `/read` to add some files read-only from another repo-B.
+This can let aider see key functions or docs from the other repo.
+- You can run `aider --show-repo-map > map.md` within each
+repo to create repo maps.
+You could then run aider in repo-A and 
+use `/read ../path/to/repo-B/map.md` to share
+a high level map of the other repo.
+- You can use aider to write documentation about a repo.
+Inside each repo, you could run `aider docs.md`
+and work with aider to write some markdown docs.
+Then while using aider to edit repo-A
+you can `/read ../path/to/repo-B/docs.md` to
+read in those docs from the other repo.
+- In repo A, ask aider to write a small script that demonstrates
+the functionality you want to use in repo B.
+Then when you're using aider in repo B, you can 
+`/read` in that script.
+
+## How do I turn on the repository map?
+
+Depending on the LLM you are using, aider may launch with the repo map disabled by default:
+
+```
+Repo-map: disabled
+```
+
+This is because weaker models get easily overwhelmed and confused by the content of the
+repo map. They sometimes mistakenly try to edit the code in the repo map.
+The repo map is usually disabled for a good reason.
+
+If you would like to force it on, you can run aider with `--map-tokens 1024`.
+
+## How do I include the git history in the context?
+
+When starting a fresh aider session, you can include recent git history in the chat context. This can be useful for providing the LLM with information about recent changes. To do this:
+
+1. Use the `/run` command with `git diff` to show recent changes:
+   ```
+   /run git diff HEAD~1
+   ```
+   This will include the diff of the last commit in the chat history.
+
+2. To include diffs from multiple commits, increase the number after the tilde:
+   ```
+   /run git diff HEAD~3
+   ```
+   This will show changes from the last three commits.
+
+Remember, the chat history already includes recent changes made during the current session, so this tip is most useful when starting a new aider session and you want to provide context about recent work.
+
+You can also use aider to review PR branches:
+
+```
+/run git diff one-branch..another-branch
+
+...
+
+Add 6.9k tokens of command output to the chat? (Y)es/(N)o [Yes]: Yes
+
+/ask Are there any problems with the way this change works with the FooBar class?
+```
+
+And of course you can prepare diff output outside of aider and provide it as
+a file for aider to read:
+
+```
+$ git diff -C10 v1..v2 > v1-v2-changes.diff
+$ aider --read v1-v2-changes.diff
+
+Aider v0.77.2.dev+import
+Main model: anthropic/claude-3-7-sonnet-20250219 with diff edit format, 8k think tokens
+──────────────────────────────────
+v1-v2-changes.diff
+> Do you see any potential bugs in this PR?
+```
+
+
+{: .tip }
+The `/git` command will not work for this purpose, as its output is not included in the chat. 
+
+## How can I run aider locally from source code?
+
+To run the project locally, follow these steps:
+
+```
+# Clone the repository
+git clone git@github.com:Aider-AI/aider.git
+
+# Navigate to the project directory
+cd aider
+
+# It's recommended to make a virtual environment
+
+# Install aider in editable/development mode, 
+# so it runs from the latest copy of these source files
+python -m pip install -e .
+
+# Run the local version of aider
+python -m aider
+```
+
+
+
+## Can I change the system prompts that aider uses?
+
+The most convenient way to add custom instructions is to use a
+[conventions file](https://aider.chat/docs/usage/conventions.html).
+
+But, aider is set up to support different actual system prompts and edit formats
+in a modular way. If you look in the `aider/coders` subdirectory, you'll
+see there's a base coder with base prompts, and then there are
+a number of
+different specific coder implementations.
+
+If you're thinking about experimenting with system prompts
+this document about
+[benchmarking GPT-3.5 and GPT-4 on code editing](https://aider.chat/docs/benchmarks.html)
+might be useful background.
+
+While it's not well documented how to add new coder subsystems, you may be able
+to modify an existing implementation or use it as a template to add another.
+
+To get started, try looking at and modifying these files.
+
+The wholefile coder is currently used by GPT-3.5 by default. You can manually select it with `--edit-format whole`.
+
+- wholefile_coder.py
+- wholefile_prompts.py
+
+The editblock coder is currently used by GPT-4o by default. You can manually select it with `--edit-format diff`.
+
+- editblock_coder.py
+- editblock_prompts.py
+
+The universal diff coder is currently used by GPT-4 Turbo by default. You can manually select it with `--edit-format udiff`.
+
+- udiff_coder.py
+- udiff_prompts.py
+
+When experimenting with coder backends, it helps to run aider with `--verbose --no-pretty` so you can see
+all the raw information being sent to/from the LLM in the conversation.
+
+You can also refer to the
+[instructions for installing a development version of aider](https://aider.chat/docs/install/optional.html#install-the-development-version-of-aider).
+
+## What LLMs do you use to build aider?
+
+Aider writes a lot of its own code, usually about 70% of the new code in each
+release.
+People often ask which LLMs I use with aider, when writing aider.
+Below is a table showing the models I have used recently,
+extracted from the 
+[public log](https://github.com/aider-ai/aider/blob/main/aider/website/assets/sample-analytics.jsonl)
+of my
+[aider analytics](https://aider.chat/docs/more/analytics.html).
+
+<!--[[[cog
+import sys
+sys.path.append(".")
+import scripts.my_models as my_models
+stats = my_models.collect_model_stats()
+html = my_models.format_html_table(stats)
+cog.out(html)
+]]]-->
+<style>
+table { border-collapse: collapse; width: 100%; }
+th, td { padding: 8px; text-align: left; border-bottom: 1px solid #ddd; }
+th { background-color: #f2f2f2; }
+tr:hover { background-color: #f5f5f5; }
+.right { text-align: right; }
+</style>
+<table>
+<tr><th>Model Name</th><th class='right'>Total Tokens</th><th class='right'>Percent</th></tr>
+<tr><td>gemini/gemini-2.5-pro</td><td class='right'>222,047</td><td class='right'>29.7%</td></tr>
+<tr><td>gpt-5</td><td class='right'>211,072</td><td class='right'>28.2%</td></tr>
+<tr><td>None</td><td class='right'>168,988</td><td class='right'>22.6%</td></tr>
+<tr><td>gemini/gemini-3-pro-preview</td><td class='right'>81,851</td><td class='right'>11.0%</td></tr>
+<tr><td>o3-pro</td><td class='right'>36,620</td><td class='right'>4.9%</td></tr>
+<tr><td>gemini/gemini-2.5-flash-lite</td><td class='right'>15,470</td><td class='right'>2.1%</td></tr>
+<tr><td>gemini/gemini-2.5-flash-lite-preview-06-17</td><td class='right'>11,371</td><td class='right'>1.5%</td></tr>
+</table>
+<!--[[[end]]]-->
+
+## How are the "aider wrote xx% of code" stats computed?
+
+[Aider is tightly integrated with git](/docs/git.html) so all
+of aider's code changes are committed to the repo with proper attribution.
+The 
+[stats are computed](https://github.com/Aider-AI/aider/blob/main/scripts/blame.py)
+by doing something like `git blame` on the repo,
+and counting up who wrote all the new lines of code in each release.
+Only lines in source code files are counted, not documentation or prompt files.
+
+## Why did aider ignore/discard its proposed edits after it asked to add a new file to the chat?
+
+If aider prompts you to add a new file to the chat and you say yes,
+it will re-submit the original request. 
+The fact that the LLM's reply indicated that it needed to see another file (and you said yes)
+is often a sign that the LLM should have been able to see/edit that file in the first place. 
+Without access to it, there is increased chance that it's done a bad implementation of the requested change.
+Often LLMs will hallucinate content for the files they needed but didn't have.
+So aider re-submits the original request in this situation.
+
+## Why does aider sometimes stop highlighting code in its replies?
+
+Aider displays the markdown responses that are coming back from the LLM.
+Usually, the LLM will reply with code in a markdown "code block" with
+triple backtick fences, like this:
+
+````
+Here's some code:
+
+```
+print("hello")
+```
+````
+
+But if you've added files to the chat that contain triple backticks,
+aider needs to tell the LLM to use a different set of fences.
+Otherwise, the LLM can't safely include your code's triple backticks
+inside the code blocks that it returns with edits.
+Aider will use fences like `<source>...</source>` in this case.
+
+A side effect of this is that the code that aider outputs may no
+longer be properly highlighted.
+You will most often notice this if you add markdown files
+to you chats that contain code blocks.
+
+## Why is the LLM speaking to me in an unexpected language?
+
+Aider goes to some effort to prompt the model to use the language that is configured
+for your system.
+But LLMs aren't fully reliable, and they sometimes decide to speak in
+an unexpected language.
+Claude is especially fond of speaking French.
+
+You can explicitly set the language that aider tells the model to use with
+`--chat-language <language>`.
+But the LLM may not comply.
+
+## Can I share my aider chat transcript?
+
+Yes, you can now share aider chat logs in a pretty way.
+
+1. Copy the markdown logs you want to share from `.aider.chat.history.md` and make a github gist. Or publish the raw markdown logs on the web any way you'd like.
+
+   ```
+   https://gist.github.com/Aider-AI/2087ab8b64034a078c0a209440ac8be0
+   ```
+
+2. Take the gist URL and append it to:
+
+   ```
+   https://aider.chat/share/?mdurl=
+   ```
+
+This will give you a URL like this, which shows the chat history like you'd see in a terminal:
+
+```
+https://aider.chat/share/?mdurl=https://gist.github.com/Aider-AI/2087ab8b64034a078c0a209440ac8be0
+```
+
+## Can I edit files myself while aider is running?
+
+Yes. Aider always reads the latest copy of files from the file
+system when you send each message.
+
+While you're waiting for aider's reply to complete, it's probably unwise to
+edit files that you've added to the chat.
+Your edits and aider's edits might conflict.
+
+## What is Aider AI LLC?
+
+Aider AI LLC is the company behind the aider AI coding tool.
+Aider is 
+[open source and available on GitHub](https://github.com/Aider-AI/aider)
+under an 
+[Apache 2.0 license](https://github.com/Aider-AI/aider/blob/main/LICENSE.txt).
+
+## Can I Script Aider?
+
+Yes. You can script aider via the command line or python. See more from here: [Scripting aider](https://aider.chat/docs/scripting.html)
+
+
+<div style="height:80vh"></div>
+

cecli/website/docs/git.md

@@ -0,0 +1,76 @@
+---
+parent: More info
+nav_order: 100
+description: Aider is tightly integrated with git.
+---
+
+# Git integration
+
+Aider works best with code that is part of a git repo.
+Aider is tightly integrated with git, which makes it easy to:
+
+  - Use the `/undo` command to instantly undo any AI changes that you don't like.
+  - Go back in the git history to review the changes that aider made to your code
+  - Manage a series of aider's changes on a git branch
+
+Aider uses git in these ways:
+
+- It asks to create a git repo if you launch it in a directory without one.
+- Whenever aider edits a file, it commits those changes with a descriptive commit message. This makes it easy to undo or review aider's changes. 
+- Aider takes special care before editing files that already have uncommitted changes (dirty files). Aider will first commit any preexisting changes with a descriptive commit message. 
+This keeps your edits separate from aider's edits, and makes sure you never lose your work if aider makes an inappropriate change.
+
+## In-chat commands
+
+Aider also allows you to use 
+[in-chat commands](/docs/usage/commands.html)
+to perform git operations:
+
+- `/diff` will show all the file changes since the last message you sent.
+- `/undo` will undo and discard the last change.
+- `/commit` to commit all dirty changes with a sensible commit message.
+- `/git` will let you run raw git commands to do more complex management of your git history.
+
+You can also manage your git history outside of aider with your preferred git tools.
+
+## Disabling git integration
+
+While it is not recommended, you can disable aider's use of git in a few ways:
+
+  - `--no-auto-commits` will stop aider from git committing each of its changes.
+  - `--no-dirty-commits` will stop aider from committing dirty files before applying its edits.
+  - `--no-git` will completely stop aider from using git on your files. You should ensure you are keeping sensible backups of the files you are working with.
+  - `--git-commit-verify` will run pre-commit hooks when making git commits. By default, aider skips pre-commit hooks by using the `--no-verify` flag (`--git-commit-verify=False`).
+
+## Commit messages
+
+Aider sends the `--weak-model` a copy of the diffs and the chat history
+and asks it to produce a commit message.
+By default, aider creates commit messages which follow
+[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
+
+You can customize the
+[commit prompt](https://github.com/Aider-AI/aider/blob/main/aider/prompts.py#L5)
+with the `--commit-prompt` option.
+You can place that on the command line, or 
+[configure it via a config file or environment variables](https://aider.chat/docs/config.html).
+
+
+## Commit attribution
+
+Aider marks commits that it either authored or committed.
+
+- If aider authored the changes in a commit, they will have "(aider)" appended to the git author and git committer name metadata.
+- If aider simply committed changes (found in dirty files), the commit will have "(aider)" appended to the git committer name metadata.
+
+You can use `--no-attribute-author` and `--no-attribute-committer` to disable
+modification of the git author and committer name fields.
+
+Additionally, you can use the following options to prefix commit messages:
+
+- `--attribute-commit-message-author`: Prefix commit messages with 'aider: ' if aider authored the changes.
+- `--attribute-commit-message-committer`: Prefix all commit messages with 'aider: ', regardless of whether aider authored the changes or not.
+
+Finally, you can use `--attribute-co-authored-by` to have aider append a Co-authored-by trailer to the end of the commit string. 
+This will disable appending `(aider)` to the git author and git committer unless you have explicitly enabled those settings.
+

cecli/website/docs/index.md

@@ -0,0 +1,47 @@
+---
+nav_exclude: true
+---
+
+# Aider Documentation
+
+Aider is AI pair programming in your terminal. This documentation will help you get the most out of aider.
+
+<div class="toc">
+{% assign pages_list = site.html_pages | sort: "nav_order" %}
+
+<ul>
+{% for page in pages_list %}
+  {% if page.title and page.url != "/" and page.parent == nil and page.nav_exclude != true %}
+    <li>
+      <a href="{{ page.url | absolute_url }}">{{ page.title }}</a>{% if page.description %} <span style="font-size: 0.9em; font-style: italic;">— {{ page.description }}</span>{% endif %}
+      
+      {% assign children = site.html_pages | where: "parent", page.title | sort: "nav_order" %}
+      {% if children.size > 0 %}
+        <ul>
+        {% for child in children %}
+          {% if child.title %}
+            <li>
+              <a href="{{ child.url | absolute_url }}">{{ child.title }}</a>{% if child.description %} <span style="font-size: 0.9em; font-style: italic;">— {{ child.description }}</span>{% endif %}
+              
+              {% assign grandchildren = site.html_pages | where: "parent", child.title | sort: "nav_order" %}
+              {% if grandchildren.size > 0 %}
+                <ul>
+                {% for grandchild in grandchildren %}
+                  {% if grandchild.title %}
+                    <li>
+                      <a href="{{ grandchild.url | absolute_url }}">{{ grandchild.title }}</a>{% if grandchild.description %} <span style="font-size: 0.9em; font-style: italic;">— {{ grandchild.description }}</span>{% endif %}
+                    </li>
+                  {% endif %}
+                {% endfor %}
+                </ul>
+              {% endif %}
+            </li>
+          {% endif %}
+        {% endfor %}
+        </ul>
+      {% endif %}
+    </li>
+  {% endif %}
+{% endfor %}
+</ul>
+</div>

cecli/website/docs/install/codespaces.md

@@ -0,0 +1,39 @@
+---
+title: GitHub Codespaces
+parent: Installation
+nav_order: 900
+---
+
+# GitHub Codespaces
+
+You can use aider in GitHub Codespaces via the built-in Terminal pane.
+See below for an example,
+but you can just follow the
+[main install instructions](/docs/install.html)
+inside your codespace terminal.
+
+
+<div class="video-container">
+  <video controls poster="/assets/codespaces.jpg">
+    <source src="/assets/codespaces.mp4" type="video/mp4">
+    <a href="/assets/codespaces.mp4">Install aider in GitHub Codespaces</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>
+

cecli/website/docs/install/docker.md

@@ -0,0 +1,48 @@
+---
+parent: Installation
+nav_order: 100
+---
+
+# cecli with docker
+
+Cecli is available as a docker image:
+
+- `dustinwashington/cecli` installs the cecli core, a smaller image that's good to get started quickly.
+
+### Aider core 
+
+```bash
+docker pull dustinwashington/cecli
+docker run \
+  -it \
+  --user $(id -u):$(id -g) \
+  --volume $(pwd):/app dustinwashington/cecli \
+  --volume $(pwd)/.aider.conf.yml:/.aider.conf.yml \
+  --volume $(pwd)/.aider.env:/.aider/.env \
+  [...other args...] \
+  --config /app/.aider.conf.yml 
+```
+
+## How to use it
+
+You should run the above commands from the root of your git repo,
+since the `--volume` arg maps your current directory into the
+docker container.
+Given that, you need to be in the root of your git repo for aider to be able to
+see the repo and all its files.
+
+You should be sure your that
+git repo config contains your user name and email, since the
+docker container won't have your global git config.
+Run these commands while in your git repo, before
+you do the `docker run` command:
+
+```
+git config user.email "you@example.com"
+git config user.name "Your Name"
+```
+
+## Limitations
+
+- When you use the in-chat `/run` command, it will be running shell commands *inside the docker container*. So those commands won't be running in your local environment, which may make it tricky to `/run` tests, etc for your project.
+- The `/voice` command won't work unless you can figure out how to give the docker container access to your host audio device. The container has libportaudio2 installed, so it should work if you can do that.

cecli/website/docs/install/optional.md

@@ -0,0 +1,100 @@
+---
+parent: Installation
+nav_order: 20
+---
+
+# Optional steps
+{: .no_toc }
+
+The steps below are completely optional.
+
+- TOC
+{:toc}
+
+## Install git
+
+Aider works best if you have git installed.
+Here are
+[instructions for installing git in various environments](https://github.com/git-guides/install-git).
+
+## Setup an API key
+
+You need an key from an API provider to work with most models:
+
+- [OpenAI](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key) provides o1, o3-mini, gpt-4o and other models. Note that paying for an API key is different than being a "ChatGPT" subscriber.
+- [Anthropic](https://docs.anthropic.com/claude/reference/getting-started-with-the-api) provides Claude 3.7 Sonnet and Haiku.
+- [DeepSeek](https://platform.deepseek.com/api_keys) provides DeepSeek R1 and DeepSeek Chat V3.
+- [OpenRouter](https://openrouter.ai/keys) allows you to access models from many providers using a single key.
+
+You can [store your api keys in configuration or env files](/docs/config/api-keys.html)
+and they will be loaded automatically whenever you run aider.
+
+## Enable Playwright 
+
+Aider supports adding web pages to the chat with the `/web <url>` command.
+When you add a url to the chat, aider fetches the page and scrapes its
+content.
+
+By default, aider uses the `httpx` library to scrape web pages, but this only
+works on a subset of web pages.
+Some sites explicitly block requests from tools like httpx.
+Others rely heavily on javascript to render the page content,
+which isn't possible using only httpx.
+
+Aider works best with all web pages if you install
+Playwright's chromium browser and its dependencies:
+
+```
+playwright install --with-deps chromium
+```
+
+See the
+[Playwright for Python documentation](https://playwright.dev/python/docs/browsers#install-system-dependencies)
+for additional information.
+
+
+## Enable voice coding 
+
+Aider supports 
+[coding with your voice](https://aider.chat/docs/usage/voice.html)
+using the in-chat `/voice` command.
+Aider uses the [PortAudio](http://www.portaudio.com) library to
+capture audio.
+Installing PortAudio is completely optional, but can usually be accomplished like this:
+
+- For Windows, there is no need to install PortAudio.
+- For Mac, do `brew install portaudio`
+- For Linux, do `sudo apt-get install libportaudio2`
+  - Some linux environments may also need `sudo apt install libasound2-plugins`
+
+## Add aider to your IDE/editor
+
+You can use 
+[aider's `--watch-files` mode](https://aider.chat/docs/usage/watch.html)
+to integrate with any IDE or editor.
+
+There are a number of 3rd party aider plugins for various IDE/editors.
+It's not clear how well they are tracking the latest
+versions of aider,
+so it may be best to just run the latest
+aider in a terminal alongside your editor and use `--watch-files`.
+
+### NeoVim
+
+[joshuavial](https://github.com/joshuavial) provided a NeoVim plugin for aider:
+
+[https://github.com/joshuavial/aider.nvim](https://github.com/joshuavial/aider.nvim)
+
+### VS Code
+
+You can run aider inside a VS Code terminal window.
+There are a number of 3rd party 
+[aider plugins for VSCode](https://marketplace.visualstudio.com/search?term=aider%20-kodu&target=VSCode&category=All%20categories&sortBy=Relevance).
+
+### Other editors
+
+If you are interested in creating an aider plugin for your favorite editor,
+please let us know by opening a
+[GitHub issue](https://github.com/Aider-AI/aider/issues).
+
+