You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-13Lines changed: 22 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@
7
7
8
8
## Overview
9
9
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.
11
11
12
12
## Installation
13
13
@@ -22,27 +22,36 @@ After installation, make sure to commit the `.ddev` directory to version control
22
22
23
23
| Command | Description |
24
24
| ------- | ----------- |
25
-
|`ddev describe`|View service status and used ports for Aider|
25
+
|`ddev aider`|Launch Aider (passing CLI options as normal)|
26
26
|`ddev logs -s aider`| Check Aider logs |
27
27
28
-
##Advanced Customization
28
+
### API Keys
29
29
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`.
31
31
32
32
```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
36
35
```
37
36
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).
39
44
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"
To make this change permanent, update the image specified in `.ddev/docker_compose.aider.yaml`.
45
54
46
55
## Credits
47
56
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