cecli-dev 0.93.1__py3-none-any.whl

cecli/website/docs/llms/openai.md

@@ -0,0 +1,58 @@
+---
+parent: Connecting to LLMs
+nav_order: 100
+---
+
+# OpenAI
+
+To work with OpenAI's models, you need to provide your
+[OpenAI API key](https://help.openai.com/en/articles/4936850-where-do-i-find-my-secret-api-key)
+either in the `OPENAI_API_KEY` environment variable or
+via the `--api-key openai=<key>` command line switch.
+
+First, install aider:
+
+{% include install.md %}
+
+Then configure your API keys:
+
+```
+export OPENAI_API_KEY=<key> # Mac/Linux
+setx   OPENAI_API_KEY <key> # Windows, restart shell after setx
+```
+
+Start working with aider and OpenAI on your codebase:
+
+```bash
+# Change directory into your codebase
+cd /to/your/project
+
+# o3-mini
+aider --model o3-mini
+
+# o1-mini
+aider --model o1-mini
+
+# GPT-4o
+aider --model gpt-4o
+
+# List models available from OpenAI
+aider --list-models openai/
+```
+
+You can use `aider --model <model-name>` to use any other OpenAI model.
+For example, if you want to use a specific version of GPT-4 Turbo
+you could do `aider --model gpt-4-0125-preview`.
+
+## Reasoning models from other providers
+
+Many of OpenAI's 
+"reasoning" models have restrictions on streaming and setting the temperature parameter.
+Some also support different levels of "reasoning effort".
+Aider is configured to work properly with these models
+when served through major provider APIs and
+has a `--reasoning-effort` setting.
+
+You may need to [configure reasoning model settings](/docs/config/reasoning.html)
+if you are using them through another provider
+and see errors related to temperature or system prompt.

cecli/website/docs/llms/openrouter.md

@@ -0,0 +1,78 @@
+---
+parent: Connecting to LLMs
+nav_order: 500
+---
+
+# OpenRouter
+
+Aider can connect to [models provided by OpenRouter](https://openrouter.ai/models?o=top-weekly):
+You'll need an [OpenRouter API key](https://openrouter.ai/keys).
+
+First, install aider:
+
+{% include install.md %}
+
+Then configure your API keys:
+
+```
+export OPENROUTER_API_KEY=<key> # Mac/Linux
+setx   OPENROUTER_API_KEY <key> # Windows, restart shell after setx
+```
+
+Start working with aider and OpenRouter on your codebase:
+
+```bash
+# Change directory into your codebase
+cd /to/your/project
+
+# Or any other open router model
+aider --model openrouter/<provider>/<model>
+
+# List models available from OpenRouter
+aider --list-models openrouter/
+```
+
+In particular, many aider users access Sonnet via OpenRouter:
+
+{: .tip }
+If you get errors, check your
+[OpenRouter privacy settings](https://openrouter.ai/settings/privacy).
+Be sure to "enable providers that may train on inputs"
+to allow use of all models.
+
+## Controlling provider selection
+
+OpenRouter often has multiple providers serving each model.
+You can control which OpenRouter providers are used for your requests in two ways:
+
+1. By "ignoring" certain providers in your
+[OpenRouter account settings](https://openrouter.ai/settings/preferences).
+This disables those named providers across all the models that you access via OpenRouter.
+
+2. By configuring "provider routing" in a `.aider.model.settings.yml` file.
+
+Place that file in your home directory or the root of your git project, with
+entries like this:
+
+```yaml
+- name: openrouter/anthropic/claude-3.7-sonnet
+  extra_params:
+    extra_body:
+      provider:
+        # Only use these providers, in this order
+        order: ["Anthropic", "Together"]
+        # Don't fall back to other providers
+        allow_fallbacks: false
+        # Skip providers that may train on inputs
+        data_collection: "deny"
+        # Only use providers supporting all parameters
+        require_parameters: true
+```
+
+See [OpenRouter's provider routing docs](https://openrouter.ai/docs/provider-routing) for full details on these settings.
+
+See [Advanced model settings](https://aider.chat/docs/config/adv-model-settings.html#model-settings)
+for more details about model settings files. 
+
+
+

cecli/website/docs/llms/other.md

@@ -0,0 +1,117 @@
+---
+parent: Connecting to LLMs
+nav_order: 800
+---
+
+# Other LLMs
+
+Aider uses the [litellm](https://docs.litellm.ai/docs/providers) package
+to connect to hundreds of other models.
+You can use `aider --model <model-name>` to use any supported model.
+
+To explore the list of supported models you can run `aider --list-models <model-name>`
+with a partial model name.
+If the supplied name is not an exact match for a known model, aider will
+return a list of possible matching models.
+For example:
+
+```
+$ aider --list-models turbo
+
+Aider v0.29.3-dev
+Models which match "turbo":
+- gpt-4-turbo-preview (openai/gpt-4-turbo-preview)
+- gpt-4-turbo (openai/gpt-4-turbo)
+- gpt-4-turbo-2024-04-09 (openai/gpt-4-turbo-2024-04-09)
+- gpt-3.5-turbo (openai/gpt-3.5-turbo)
+- ...
+```
+
+See the [model warnings](warnings.html)
+section for information on warnings which will occur
+when working with models that aider is not familiar with.
+
+## LiteLLM
+
+Aider uses the LiteLLM package to connect to LLM providers.
+The [LiteLLM provider docs](https://docs.litellm.ai/docs/providers)
+contain more detail on all the supported providers,
+their models and any required environment variables.
+
+
+## Other API key variables
+
+Here are the API key environment variables that are supported
+by litellm. See their docs for more info.
+
+<!--[[[cog
+from subprocess import run
+lines = run(
+    "egrep -ho '[A-Z_]+_API_KEY' ../litellm/litellm/*py | sort -u",
+    shell=True,
+    capture_output=True,
+    text=True,
+    ).stdout
+lines = ['- ' + line for line in lines.splitlines(keepends=True)]
+cog.out(''.join(lines))
+]]]-->
+- ALEPH_ALPHA_API_KEY
+- ALEPHALPHA_API_KEY
+- ANTHROPIC_API_KEY
+- ANYSCALE_API_KEY
+- ARK_API_KEY
+- AZURE_AI_API_KEY
+- AZURE_API_KEY
+- AZURE_OPENAI_API_KEY
+- BASETEN_API_KEY
+- BYTEZ_API_KEY
+- CEREBRAS_API_KEY
+- CLARIFAI_API_KEY
+- CLOUDFLARE_API_KEY
+- CO_API_KEY
+- CODESTRAL_API_KEY
+- COHERE_API_KEY
+- COMPACTIFAI_API_KEY
+- DASHSCOPE_API_KEY
+- DATABRICKS_API_KEY
+- DEEPINFRA_API_KEY
+- DEEPSEEK_API_KEY
+- FEATHERLESS_AI_API_KEY
+- FIREWORKS_AI_API_KEY
+- FIREWORKS_API_KEY
+- FIREWORKSAI_API_KEY
+- GEMINI_API_KEY
+- GOOGLE_API_KEY
+- GROQ_API_KEY
+- HUGGINGFACE_API_KEY
+- INFINITY_API_KEY
+- MARITALK_API_KEY
+- MISTRAL_API_KEY
+- MOONSHOT_API_KEY
+- NEBIUS_API_KEY
+- NLP_CLOUD_API_KEY
+- NOVITA_API_KEY
+- NVIDIA_NIM_API_KEY
+- OLLAMA_API_KEY
+- OPENAI_API_KEY
+- OPENAI_LIKE_API_KEY
+- OPENROUTER_API_KEY
+- OR_API_KEY
+- OVHCLOUD_API_KEY
+- PALM_API_KEY
+- PERPLEXITYAI_API_KEY
+- PREDIBASE_API_KEY
+- PROVIDER_API_KEY
+- REPLICATE_API_KEY
+- SAMBANOVA_API_KEY
+- TOGETHERAI_API_KEY
+- USER_API_KEY
+- VERCEL_AI_GATEWAY_API_KEY
+- VOLCENGINE_API_KEY
+- VOYAGE_API_KEY
+- WANDB_API_KEY
+- WATSONX_API_KEY
+- WX_API_KEY
+- XAI_API_KEY
+- XINFERENCE_API_KEY
+<!--[[[end]]]-->

cecli/website/docs/llms/vertex.md

@@ -0,0 +1,50 @@
+---
+parent: Connecting to LLMs
+nav_order: 550
+---
+
+# Vertex AI
+
+Aider can connect to models provided by Google Vertex AI.
+You will need to install the
+[gcloud CLI](https://cloud.google.com/sdk/docs/install) and [login](https://cloud.google.com/sdk/docs/initializing) with a GCP account
+or service account with permission to use the Vertex AI API.
+
+With your chosen login method, the gcloud CLI should automatically set the
+`GOOGLE_APPLICATION_CREDENTIALS` environment variable which points to the credentials file.
+
+First, install aider:
+
+{% include install.md %}
+
+To configure Aider to use the Vertex AI API, you need to set `VERTEXAI_PROJECT` (the GCP project ID)
+and `VERTEXAI_LOCATION` (the GCP region) [environment variables for Aider](/docs/config/dotenv.html).
+
+Note that Claude on Vertex AI is only available in certain GCP regions, 
+check [the model card](https://console.cloud.google.com/vertex-ai/publishers/anthropic/model-garden/claude-3-5-sonnet) 
+for your model to see which regions are supported.
+
+Example `.env` file:
+
+```
+VERTEXAI_PROJECT=my-project
+VERTEXAI_LOCATION=us-east5
+```
+
+Start working with aider and Vertex AI on your codebase:
+
+```
+# Change directory into your codebase
+cd /to/your/project
+
+aider --model vertex_ai/claude-3-5-sonnet@20240620
+```
+
+Or you can use the [YAML config](/docs/config/aider_conf.html) to set the model to any of the 
+models supported by Vertex AI.
+
+Example `.aider.conf.yml` file:
+
+```yaml
+model: vertex_ai/claude-3-5-sonnet@20240620
+```

cecli/website/docs/llms/warnings.md

@@ -0,0 +1,10 @@
+---
+parent: Connecting to LLMs
+nav_order: 900
+---
+
+# Model warnings
+
+{% include model-warnings.md %}
+
+

cecli/website/docs/llms/xai.md

@@ -0,0 +1,53 @@
+---
+parent: Connecting to LLMs
+nav_order: 400
+---
+
+# xAI
+
+You'll need a [xAI API key](https://console.x.ai.).
+
+First, install aider:
+
+{% include install.md %}
+
+Then configure your API keys:
+
+```bash
+export XAI_API_KEY=<key> # Mac/Linux
+setx   XAI_API_KEY <key> # Windows, restart shell after setx
+```
+
+Start working with aider and xAI on your codebase:
+
+```bash
+# Change directory into your codebase
+cd /to/your/project
+
+# Grok 3
+aider --model xai/grok-3-beta
+
+# Grok 3 fast (faster, more expensive)
+aider --model xai/grok-3-fast-beta
+
+# Grok 3 Mini
+aider --model xai/grok-3-mini-beta
+
+# Grok 3 Mini fast (faster, more expensive)
+aider --model xai/grok-3-mini-fast-beta
+
+# List models available from xAI
+aider --list-models xai/
+```
+
+The Grok 3 Mini models support the `--reasoning-effort` flag.
+See the [reasoning settings documentation](../config/reasoning.md) for details.
+Example:
+
+```bash
+aider --model xai/grok-3-mini-beta --reasoning-effort high
+```
+
+
+
+

cecli/website/docs/llms.md

@@ -0,0 +1,54 @@
+---
+title: Connecting to LLMs
+nav_order: 40
+has_children: true
+description: Aider can connect to most LLMs for AI pair programming.
+---
+
+# Aider can connect to most LLMs
+{: .no_toc }
+
+[![connecting to many LLMs](/assets/llms.jpg)](https://aider.chat/assets/llms.jpg)
+
+
+## Best models
+{: .no_toc }
+
+Aider works best with these models, which are skilled at editing code:
+
+- [Gemini 2.5 Pro](/docs/llms/gemini.html)
+- [DeepSeek R1 and V3](/docs/llms/deepseek.html)
+- [Claude 3.7 Sonnet](/docs/llms/anthropic.html)
+- [OpenAI o3, o4-mini and GPT-4.1](/docs/llms/openai.html)
+
+
+## Free models
+{: .no_toc }
+
+Aider works with a number of **free** API providers:
+
+- [OpenRouter offers free access to many models](https://openrouter.ai/models/?q=free), with limitations on daily usage.
+- Google's [Gemini 2.5 Pro Exp](/docs/llms/gemini.html) works very well with aider.
+
+## Local models
+{: .no_toc }
+
+Aider can work also with local models, for example using [Ollama](/docs/llms/ollama.html).
+It can also access
+local models that provide an
+[Open AI compatible API](/docs/llms/openai-compat.html).
+
+## Use a capable model
+{: .no_toc }
+
+Check
+[Aider's LLM leaderboards](https://aider.chat/docs/leaderboards/)
+to see which models work best with aider.
+
+Be aware that aider may not work well with less capable models.
+If you see the model returning code, but aider isn't able to edit your files
+and commit the changes...
+this is usually because the model isn't capable of properly
+returning "code edits".
+Models weaker than GPT 3.5 may have problems working well with aider.
+

cecli/website/docs/more/analytics.md

@@ -0,0 +1,127 @@
+---
+parent: More info
+nav_order: 500
+description: Opt-in, anonymous, no personal info.
+---
+
+# Analytics
+
+Aider can collect anonymous analytics to help
+improve aider's ability to work with LLMs, edit code and complete user requests.
+
+## Opt-in, anonymous, no personal info
+
+Analytics are only collected if you agree and opt-in. 
+Aider respects your privacy and never collects your code, chat messages, keys or
+personal info.
+
+Aider collects information on:
+
+- which LLMs are used and with how many tokens,
+- which of aider's edit formats are used,
+- how often features and commands are used,
+- information about exceptions and errors,
+- etc
+
+These analytics are associated with an anonymous,
+randomly generated UUID4 user identifier.
+
+This information helps improve aider by identifying which models, edit formats,
+features and commands are most used.
+It also helps uncover bugs that users are experiencing, so that they can be fixed
+in upcoming releases.
+
+## Disabling analytics
+
+You can opt out of analytics forever by running this command one time:
+
+```
+aider --analytics-disable
+```
+
+## Enabling analytics
+
+The `--[no-]analytics` switch controls whether analytics are enabled for the
+current session:
+
+- `--analytics` will turn on analytics for the current session.
+This will *not* have any effect if you have permanently disabled analytics 
+with `--analytics-disable`.
+If this is the first time you have enabled analytics, aider
+will confirm you wish to opt-in to analytics.
+- `--no-analytics` will turn off analytics for the current session.
+- By default, if you don't provide `--analytics` or `--no-analytics`,
+aider will enable analytics for a random subset of users.
+Such randomly selected users will be asked if they wish to opt-in to analytics.
+This will never happen if you have permanently disabled analytics 
+with `--analytics-disable`.
+
+## Opting in
+
+The first time analytics are enabled, you will need to agree to opt-in.
+
+```
+aider --analytics
+
+Aider respects your privacy and never collects your code, prompts, chats, keys or any personal
+info.
+For more info: https://aider.chat/docs/more/analytics.html
+Allow collection of anonymous analytics to help improve aider? (Y)es/(N)o [Yes]:
+```
+
+If you say "no", analytics will be permanently disabled.
+
+
+## Details about data being collected
+
+### Sample analytics data
+
+To get a better sense of what type of data is collected, you can review some
+[sample analytics logs](https://github.com/aider-ai/aider/blob/main/aider/website/assets/sample-analytics.jsonl).
+These are the last 1,000 analytics events from the author's
+personal use of aider, updated regularly.
+
+
+### Analytics code
+
+Since aider is open source, all the places where aider collects analytics
+are visible in the source code.
+They can be viewed using 
+[GitHub search](https://github.com/search?q=repo%3Aaider-ai%2Faider+%22.event%28%22&type=code).
+
+
+### Logging and inspecting analytics
+
+You can get a full log of the analytics that aider is collecting,
+in case you would like to audit or inspect this data.
+
+```
+aider --analytics-log filename.jsonl
+```
+
+If you want to just log analytics without reporting them, you can do:
+
+```
+aider --analytics-log filename.jsonl --no-analytics
+```
+
+### Sending analytics to custom PostHog project or installation
+
+Aider uses PostHog for analytics collection. You can configure aider to send analytics to your own PostHog project or a custom PostHog installation using these parameters:
+
+- `--analytics-posthog-project-api-key KEY` - Set a custom PostHog project API key
+- `--analytics-posthog-host HOST` - Set a custom PostHog host (default is app.posthog.com)
+
+## Reporting issues
+
+If you have concerns about any of the analytics that aider is collecting
+or our data practices
+please contact us by opening a
+[GitHub Issue](https://github.com/aider-ai/aider/issues).
+
+## Privacy policy
+
+Please see aider's
+[privacy policy](/docs/legal/privacy.html)
+for more details.
+

cecli/website/docs/more/edit-formats.md

@@ -0,0 +1,116 @@
+---
+parent: More info
+nav_order: 490
+description: Aider uses various "edit formats" to let LLMs edit source files.
+---
+
+# Edit formats
+
+Aider uses various "edit formats" to let LLMs edit source files.
+Different models work better or worse with different edit formats.
+Aider is configured to use the optimal format for most popular, common models.
+You can always force use of a specific edit format with 
+the `--edit-format` switch.
+
+## whole
+
+The "whole" edit format is the simplest possible editing format.
+The LLM is instructed to return a full, updated
+copy of each source file that needs changes.
+While simple, it can be slow and costly because the LLM has to return
+the *entire file* even if just a few lines are edited.
+
+The whole format expects the file path just before the fenced file content:
+
+````
+show_greeting.py
+```
+import sys
+
+def greeting(name):
+    print("Hey", name)
+
+if __name__ == '__main__':
+    greeting(sys.argv[1])
+```
+````
+
+
+## diff
+
+The "diff" edit format asks the LLM to specify file edits as a series of search/replace blocks.
+This is an efficient format, because the model only needs to return parts of the file
+which have changes.
+
+Edits are formatted using a syntax similar to the git merge conflict resolution markings,
+with the file path right before a fenced block:
+
+````
+mathweb/flask/app.py
+```
+<<<<<<< SEARCH
+from flask import Flask
+=======
+import math
+from flask import Flask
+>>>>>>> REPLACE
+```
+````
+
+## diff-fenced
+
+The "diff-fenced" edit format is based on the diff format, but
+the file path is placed inside the fence.
+It is primarily used with the Gemini family of models,
+which often fail to conform to the fencing approach specified in the diff format.
+
+````
+```
+mathweb/flask/app.py
+<<<<<<< SEARCH
+from flask import Flask
+=======
+import math
+from flask import Flask
+>>>>>>> REPLACE
+```
+````
+
+## udiff
+
+The "udiff" edit format is based on the widely used unified diff format,
+but [modified and simplified](/2023/12/21/unified-diffs.html).
+This is an efficient format, because the model only needs to return parts of the file
+which have changes.
+
+It was mainly used to the GPT-4 Turbo family of models,
+because it reduced their "lazy coding" tendencies.
+With other edit formats the GPT-4 Turbo models tended to elide
+large sections of code and replace them with "# ... original code here ..."
+style comments.
+
+
+````
+```diff
+--- mathweb/flask/app.py
++++ mathweb/flask/app.py
+@@ ... @@
+-class MathWeb:
++import sympy
++
++class MathWeb:
+```
+````
+
+## editor-diff and editor-whole
+
+These are streamlined versions of the diff and whole formats, intended to be used
+with `--editor-edit-format` when using
+[architect mode](/docs/usage/modes.html).
+The actual edit format is the same, but aider uses a simpler prompt that
+is more narrowly focused on just editing the file as opposed to
+solving the coding task.
+The architect model resolves the coding task and
+provides plain text instructions about which file changes need to be made.
+The editor interprets those instructions to produce the
+syntactically correct diff or whole edits.