diff --git a/aider/website/_includes/special-keys.md b/aider/website/_includes/special-keys.md index 7b0495685..dc7342916 100644 --- a/aider/website/_includes/special-keys.md +++ b/aider/website/_includes/special-keys.md @@ -1,6 +1,9 @@ Aider has special support for providing OpenAI and Anthropic API keys -via command line switches and yaml config settings. +via +[command line switches](/docs/config/options.html) +and +[yaml config file](/docs/config/aider_conf.html). *All other LLM providers* must have their keys and settings specified in environment variables. diff --git a/aider/website/docs/config/aider_conf.md b/aider/website/docs/config/aider_conf.md index 25561a5a0..f7ebce607 100644 --- a/aider/website/docs/config/aider_conf.md +++ b/aider/website/docs/config/aider_conf.md @@ -6,14 +6,23 @@ description: How to configure aider with a yaml config file. # YAML config file -Most of aider's options can be set in an `.aider.conf.yml` file, -which can be placed in your home directory or at the root of -your git repo. +Most of aider's options can be set in an `.aider.conf.yml` file. +Aider will look for a this file in these locations and +load whichever is found first. + +- As specified with the `--config ` parameter. +- The current directory. +- The root of your git repo. +- Your home directory. + +## Storing LLM keys {% include special-keys.md %} {% include env-keys-tip.md %} +## Sample YAML config file + Below is a sample of the YAML config file, which you can also [download from GitHub](https://github.com/paul-gauthier/aider/blob/main/aider/website/assets/sample.aider.conf.yml). diff --git a/aider/website/docs/config/dotenv.md b/aider/website/docs/config/dotenv.md index d82fc215e..df54fd608 100644 --- a/aider/website/docs/config/dotenv.md +++ b/aider/website/docs/config/dotenv.md @@ -11,8 +11,6 @@ models you use with aider. You can also set many general aider options in the `.env` file. -{% include special-keys.md %} - Aider will look for a `.env` file in these locations: - Your home directory. @@ -22,6 +20,12 @@ Aider will look for a `.env` file in these locations: If the files above exist, they will be loaded in that order. Files loaded last will take priority. +## Storing LLM keys + +{% include special-keys.md %} + +## Sample .env file + Below is a sample `.env` file, which you can also [download from GitHub](https://github.com/paul-gauthier/aider/blob/main/aider/website/assets/sample.env). diff --git a/aider/website/docs/config/options.md b/aider/website/docs/config/options.md index 4d17386f5..4a3aeed2b 100644 --- a/aider/website/docs/config/options.md +++ b/aider/website/docs/config/options.md @@ -13,6 +13,11 @@ or review them below. - TOC {:toc} +## LLM keys +{: .no_toc } + +{% include special-keys.md %} + ## Usage summary