Skip to content

Commit b8f710a

Browse files
committed
docs: Update README
1 parent 2178e5b commit b8f710a

1 file changed

Lines changed: 22 additions & 13 deletions

File tree

README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
## Overview
99

10-
This add-on integrates Aider into your [DDEV](https://ddev.com/) project.
10+
This add-on integrates [Aider](https://aider.chat/) (an AI pair-programming tool) into your [DDEV](https://ddev.com/) project.
1111

1212
## Installation
1313

@@ -22,27 +22,36 @@ After installation, make sure to commit the `.ddev` directory to version control
2222

2323
| Command | Description |
2424
| ------- | ----------- |
25-
| `ddev describe` | View service status and used ports for Aider |
25+
| `ddev aider` | Launch Aider (passing CLI options as normal) |
2626
| `ddev logs -s aider` | Check Aider logs |
2727

28-
## Advanced Customization
28+
### API Keys
2929

30-
To change the Docker image:
30+
To use Aider, it must connect to an LLM. We recommend using locally hosted LLMs whenever possible. However, when a commercial LLM is used, an API key must be provided. As such, we recommend using `.ddev/.env.aider` to provide API keys. Obviously, you should take steps to avoid inadvertently committing keys into your version control system. So we also *highly recommend* adding `.ddev/.env.aider` to your `.gitignore`.
3131

3232
```bash
33-
ddev dotenv set .ddev/.env.aider --aider-docker-image="ddev/ddev-utilities:latest"
34-
ddev add-on get consensus-enterprises/ddev-aider
35-
ddev restart
33+
ddev dotenv set .ddev/.env.aider --gemini-api-key=...
34+
echo .ddev/.env.aider >> .gitignore
3635
```
3736

38-
Make sure to commit the `.ddev/.env.aider` file to version control.
37+
For a full list of supported LLMs, review the [API key environment variables](https://aider.chat/docs/llms/other.html#other-api-key-variables) in the docs.
38+
39+
## Advanced Configuration
40+
41+
It is common to commit `.env.<service>` files associated with DDEV add-ons, especially to provide service-specific configuration. However, in this case, we recommend using a configuration file (`.ddev/aider.conf.yml`) instead.
42+
43+
To customize the behaviour of Aider, edit the provided `.ddev/aider.conf.yml`. For a full list of available options, refer to the [Aider config docs](https://aider.chat/docs/config/aider_conf.html).
3944

40-
All customization options (use with caution):
45+
### Override Docker image
46+
47+
To temporarily change the Docker image:
48+
```
49+
ddev dotenv set .ddev/.env.aider --aider-docker-image="paulgauthier/aider-full:latest"
50+
ddev restart
51+
```
4152

42-
| Variable | Flag | Default |
43-
| -------- | ---- | ------- |
44-
| `AIDER_DOCKER_IMAGE` | `--aider-docker-image` | `ddev/ddev-utilities:latest` |
53+
To make this change permanent, update the image specified in `.ddev/docker_compose.aider.yaml`.
4554

4655
## Credits
4756

48-
**Contributed and maintained by [@consensus-enterprises](https://github.com/consensus-enterprises)**
57+
**Contributed and maintained by [@ergonlogic](https://gitlab.com/ergonlogic) (Christopher Gervais) and [@star-szr](https://gitlab.com/star-szr) (Scott Zhu Reeves) on behalf of [Consensus Enterprises](https://consensus.enterprises).**

0 commit comments

Comments
 (0)