mirror of https://github.com/Aider-AI/aider.git synced 2025-05-28 08:14:59 +00:00

2024-04-22 17:10:37 -07:00

7.8 KiB

Raw Blame History

Aider can connect to most LLMs

Aider works best with GPT-4 Turbo and Claude 3 Opus, as they are the very best models for editing code. Aider also works quite well with GPT-3.5.

To use aider with a free API provider, you can use Llama 3 70B on Groq which is comparable to GPT-3.5 in code editing performance. Cohere also offers free API access to their Command-R+ model, which works with aider as a very basic coding assistant.

Aider supports connecting to almost any LLM, but it may not work well with some models depending on their capabilities. For example, GPT-3.5 is just barely capable of reliably editing code to provide aider's interactive "pair programming" style workflow. So you should expect that models which are less capable than GPT-3.5 may struggle to perform well with aider.

OpenAI

To work with OpenAI's models, you need to provide your OpenAI API key either in the OPENAI_API_KEY environment variable or via the --openai-api-key command line switch.

Aider has some built in shortcuts for the most popular OpenAI models and has been tested and benchmarked to work well with them:

export OPENAI_API_KEY=<your-key-goes-here>

# GPT-4 Turbo is used by default
aider

# GPT-4 Turbo with Vision
aider --4-turbo-vision

# GPT-3.5 Turbo
aider --35-turbo

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.

Anthropic

To work with Anthropic's models, you need to provide your Anthropic API key either in the ANTHROPIC_API_KEY environment variable or via the --anthropic-api-key command line switch.

Aider has some built in shortcuts for the most popular Anthropic models and has been tested and benchmarked to work well with them:

export ANTHROPIC_API_KEY=<your-key-goes-here>

# Claude 3 Opus
aider --opus

# Claude 3 Sonnet
aider --sonnet

You can use aider --model <model-name> to use any other Anthropic model. For example, if you want to use a specific version of Opus you could do aider --model claude-3-opus-20240229.

GROQ

Groq currently offers free API access to the models they host. The Llama 3 70B model works well with aider and is comparable to GPT-3.5 in code editing performance. You'll need a Groq API key.

To use Llama3 70B:

export GROQ_API_KEY=<your-key-goes-here>
aider --model groq/llama3-70b-8192

Cohere

Cohere offers free API access to their models. Their Command-R+ model works well with aider as a very basic coding assistant. You'll need a Cohere API key.

To use Command-R+:

export COHERE_API_KEY=<your-key-goes-here>
aider --model command-r-plus

Azure

Aider can connect to the OpenAI models on Azure.

export AZURE_API_KEY=<your-key-goes-here>
export AZURE_API_VERSION=2023-05-15
export AZURE_API_BASE=https://example-endpoint.openai.azure.com
aider --model azure/<your_deployment_name>

OpenRouter

Aider can connect to models provided by OpenRouter:

export OPENROUTER_API_KEY=<your-key-goes-here>

# Llama3 70B instruct
aider --model openrouter/meta-llama/llama-3-70b-instruct

# Or any other open router model
aider --model openrouter/<provider>/<model>

OpenAI compatible APIs

Aider can connect to any LLM which is accessible via an OpenAI compatible API endpoint. Use --openai-api-base or set the OPENAI_API_BASE environment variable to have aider connect to it.

export OPENAI_API_BASE=<your-endpoint-goes-here>
export OPENAI_API_KEY=<your-key-goes-here-if-required>
aider --model <model-name>

See the model warnings section for information on warnings which will occur when working with models that aider is not familiar with.

Other LLMs

Aider uses the litellm 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 --model <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 --model turbo

Model turbo: Unknown model, context window size and token costs unavailable.
Did you mean one of these?
- gpt-4-turbo-preview
- gpt-4-turbo
- gpt-4-turbo-2024-04-09
- gpt-3.5-turbo
- gpt-3.5-turbo-0301
...

See the list of providers supported by litellm for more details.

Model warnings

On startup, aider tries to sanity check that it is configured correctly to work with the specified models:

It checks to see that all required environment variables are set for the model. These variables are required to configure things like API keys, API base URLs, etc.
It checks a metadata database to look up the context window size and token costs for the model.

Sometimes one or both of these checks will fail, so aider will issue some of the following warnings.

Missing environment variables

Model azure/gpt-4-turbo: Missing these environment variables:
- AZURE_API_BASE
- AZURE_API_VERSION
- AZURE_API_KEY

You need to set the listed environment variables. Otherwise you will get error messages when you start chatting with the model.

Unknown which environment variables are required

Model gpt-5: Unknown which environment variables are required.

Aider is unable verify the environment because it doesn't know which variables are required for the model. If required variables are missing, you may get errors when you attempt to chat with the model. You can look in the litellm provider documentation to see if the required variables are listed there.

Unknown model, did you mean?

Model gpt-5: Unknown model, context window size and token costs unavailable.
Did you mean one of these?
- gpt-4

If you specify a model that aider has never heard of, you will get an "unknown model" warning. This means aider doesn't know the context window size and token costs for that model. Some minor functionality will be limited when using such models, but it's not really a significant problem.

Aider will also try to suggest similarly named models, in case you made a typo or mistake when specifying the model name.

Editing format

Aider uses 3 different "edit formats" to collect code edits from different LLMs:

whole is a "whole file" editing format, where the model edits a file by returning a full new copy of the file with any changes included.
diff is a more efficient diff style format, where the model specifies blocks of code to search and replace in order to made changes to files.
udiff is the most efficient editing format, where the model returns unified diffs to apply changes to the file.

Different models work best with different editing formats. Aider is configured to use the best edit format for all the popular OpenAI and Anthropic models.

For lesser known models aider will default to using the "whole" editing format. If you would like to experiment with the more advanced formats, you can use these switches: --edit-format diff or --edit-format udiff.

7.8 KiB Raw Blame History