diff --git a/aider/args_formatter.py b/aider/args_formatter.py index cc7e3e73d..f2f1df195 100644 --- a/aider/args_formatter.py +++ b/aider/args_formatter.py @@ -96,6 +96,10 @@ class YamlHelpFormatter(argparse.HelpFormatter): # Place in your home dir, or at the root of your git repo. ########################################################## +# Note: You can only put OpenAI and Anthropic API keys in the yaml +# config file. Keys for all APIs can be stored in a .env file +# https://aider.chat/docs/config/dotenv.html + """ def _format_action(self, action): diff --git a/aider/website/_config.yml b/aider/website/_config.yml index 7d8f53af0..b95a2a158 100644 --- a/aider/website/_config.yml +++ b/aider/website/_config.yml @@ -37,3 +37,8 @@ nav_external_links: url: "https://discord.gg/Tv2uQnR88V" repository: paul-gauthier/aider + +callouts: + tip: + title: Tip + color: green \ No newline at end of file diff --git a/aider/website/_includes/env-keys-tip.md b/aider/website/_includes/env-keys-tip.md new file mode 100644 index 000000000..634c41d06 --- /dev/null +++ b/aider/website/_includes/env-keys-tip.md @@ -0,0 +1,6 @@ +{: .tip } +All API keys can be stored in a +Use a [.env file](/docs/config/dotenv.html) to store API keys. +OpenAI and Anthropic keys can be stored in the +[YAML config file](/docs/config/aider_conf.html). + diff --git a/aider/website/_includes/help-tip.md b/aider/website/_includes/help-tip.md new file mode 100644 index 000000000..0f90d0d46 --- /dev/null +++ b/aider/website/_includes/help-tip.md @@ -0,0 +1,4 @@ +{: .tip } +Use `/help ` to ask aider about itself. +You can ask how to customize options or troubleshoot +errors and warnings. diff --git a/aider/website/_includes/model-warnings.md b/aider/website/_includes/model-warnings.md index aaba1f0b1..bcf483b48 100644 --- a/aider/website/_includes/model-warnings.md +++ b/aider/website/_includes/model-warnings.md @@ -5,8 +5,6 @@ Model foobar: Unknown context window size and costs, using sane defaults. ``` -*You can probably ignore the unknown context window size and token costs warning.* - If you specify a model that aider has never heard of, you will get this warning. This means aider doesn't know the context window size and token costs @@ -18,6 +16,9 @@ See the docs on [configuring advanced model settings](/docs/config/adv-model-settings.html) for details on how to remove this warning. +{: .tip } +You can probably ignore the unknown context window size and token costs warning. + ## Did you mean? If aider isn't familiar with the model you've specified, diff --git a/aider/website/assets/sample.aider.conf.yml b/aider/website/assets/sample.aider.conf.yml index afadcbecb..e5bc4ca95 100644 --- a/aider/website/assets/sample.aider.conf.yml +++ b/aider/website/assets/sample.aider.conf.yml @@ -4,6 +4,10 @@ # Place in your home dir, or at the root of your git repo. ########################################################## +# Note: You can only put OpenAI and Anthropic API keys in the yaml +# config file. Keys for all APIs can be stored in a .env file +# https://aider.chat/docs/config/dotenv.html + ########## # options: diff --git a/aider/website/docs/config.md b/aider/website/docs/config.md index 1aeb6e975..40087c936 100644 --- a/aider/website/docs/config.md +++ b/aider/website/docs/config.md @@ -39,3 +39,6 @@ Using an `.env` file: ``` AIDER_DARK_MODE=true ``` + +{% include env-keys-tip.md %} + diff --git a/aider/website/docs/config/aider_conf.md b/aider/website/docs/config/aider_conf.md index da7c02831..6a6799ab8 100644 --- a/aider/website/docs/config/aider_conf.md +++ b/aider/website/docs/config/aider_conf.md @@ -16,6 +16,8 @@ Below is a sample of the file, which you can also [download from GitHub](https://github.com/paul-gauthier/aider/blob/main/aider/website/assets/sample.aider.conf.yml). +{% include env-keys-tip.md %} +