updated install instructions

This commit is contained in:
Paul Gauthier 2024-12-15 08:39:53 -08:00
parent 10b5aaa6a5
commit a67ac81265
12 changed files with 100 additions and 229 deletions

View file

@ -9,7 +9,7 @@ or
If you are using aider to work on a python project, sometimes your project will require
specific versions of python packages which conflict with the versions that aider
requires.
If this happens, the `python -m pip install aide-chat` command may return errors like these:
If this happens, the `python -m pip install aider-chat` command may return errors like these:
```
aider-chat 0.23.0 requires somepackage==X.Y.Z, but you have somepackage U.W.V which is incompatible.

View file

@ -1,5 +1,5 @@
You can get started quickly like this:
You can get started quickly like this, with python 3.8-3.13:
```bash
python -m pip install aider-install

View file

@ -1,49 +1 @@
Aider has special support for providing
OpenAI and Anthropic API keys
via dedicated
[command line switches](/docs/config/options.html#api-keys-and-settings)
`--openai-api-key` and `--anthropic-api-key`.
You can also set those API keys via special entries in the
[yaml config file](/docs/config/aider_conf.html), like this:
```yaml
openai-api-key: <key>
anthropic-api-key: <key>
```
All other LLM providers can use one of the following methods to set their
keys:
### API keys on the command line
{: .no_toc }
Use `--api-key provider=<key>` which has the effect of setting the environment variable `PROVIDER_API_KEY=<key>`. So `--api-key gemini=xxx` would set `GEMINI_API_KEY=xxx`.
### API keys in a .env file
{: .no_toc }
The [.env file](/docs/config/dotenv.html)
is a great place to set API keys and other provider API environment variables:
```bash
GEMINI_API_KEY=foo
OPENROUTER_API_KEY=bar
DEEPSEEK_API_KEY=baz
```
### API keys in .aider.conf.yml
{: .no_toc }
Or you can set API keys in the
[`.aider.conf.yml` file](/docs/config/aider_conf.html)
via the `api-key` entry:
```
api-key:
- gemini=foo # Sets env var GEMINI_API_KEY=foo
- openrouter=bar # Sets env var OPENROUTER_API_KEY=bar
- deepseek=baz # Sets env var DEEPSEEK_API_KEY=baz
```

View file

@ -1,5 +0,0 @@
{: .tip }
Other recommended ways to install aider are via
[pipx](/docs/install/pipx.html)
or
[uv](/docs/install/uv.html).