Skip to content

Commit 52b7dbc

Browse files
committed
README: Example config file
1 parent 7f813af commit 52b7dbc

1 file changed

Lines changed: 39 additions & 2 deletions

File tree

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
### Documentation and Other Notes
1+
## Documentation and Other Notes
22
* [Agent Mode](https://github.com/dwash96/aider-ce/blob/main/aider/website/docs/config/agent-mode.md)
33
* [MCP Configuration](https://github.com/dwash96/aider-ce/blob/main/aider/website/docs/config/mcp.md)
44
* [Session Management](https://github.com/dwash96/aider-ce/blob/main/aider/website/docs/sessions.md)
55
* [Aider Original Documentation (still mostly applies)](https://aider.chat/)
66
* [Changelog](https://github.com/dwash96/aider-ce/blob/main/CHANGELOG.md)
77
* [Discord Community](https://discord.gg/McwdCRuqkJ)
88

9-
### Installation Instructions
9+
## Installation Instructions
1010
This project can be installed using several methods:
1111

1212
### Package Installation
@@ -29,6 +29,43 @@ uv tool install --python python3.12 aider-ce
2929

3030
Use the tool installation so aider doesn't interfere with your development environment
3131

32+
## Configuration
33+
34+
The documentation above contains the full set of allowed configuration options
35+
but I highly recommend using an `.aider.conf.yml` file. A good place to get started is:
36+
37+
```yaml
38+
model: <model of your choice>
39+
agent: true
40+
analytics: false
41+
auto-commits: true
42+
auto-save: true
43+
auto-load: true
44+
check-update: true
45+
debug: false
46+
enable-context-compaction: true
47+
env-file: .aider.env
48+
multiline: true
49+
preserve-todo-list: true
50+
show-model-warnings: true
51+
watch-files: true
52+
agent-config: |
53+
{
54+
"large_file_token_threshold": 12500,
55+
"skip_cli_confirmations": false
56+
}
57+
mcp-servers: |
58+
{
59+
"mcpServers":
60+
{
61+
"context7":{
62+
"transport":"http",
63+
"url":"https://mcp.context7.com/mcp"
64+
}
65+
}
66+
}
67+
```
68+
3269
## Project Roadmap/Goals
3370
3471
The current priorities are to improve core capabilities and user experience of the Aider project

0 commit comments

Comments
 (0)