Skip to content
This repository was archived by the owner on May 15, 2025. It is now read-only.

Commit 838f259

Browse files
docs(aider): update README to include experiment task conventions parameter for enhanced task reporting
1 parent 3b4e85a commit 838f259

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

aider/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,22 +31,22 @@ module "aider" {
3131

3232
## Module Parameters
3333

34-
| Parameter | Description | Type | Default |
35-
| ---------------------------------- | --------------------------------------------------------------------------- | -------- | ------------------- |
36-
| `agent_id` | The ID of a Coder agent (required) | `string` | - |
37-
| `folder` | The folder to run Aider in | `string` | `/home/coder` |
38-
| `install_aider` | Whether to install Aider | `bool` | `true` |
39-
| `aider_version` | The version of Aider to install | `string` | `"latest"` |
40-
| `use_screen` | Whether to use screen for running Aider in the background | `bool` | `true` |
41-
| `use_tmux` | Whether to use tmux instead of screen for running Aider in the background | `bool` | `false` |
42-
| `session_name` | Name for the persistent session (screen or tmux) | `string` | `"aider"` |
43-
| `order` | Position of the app in the UI presentation | `number` | `null` |
44-
| `icon` | The icon to use for the app | `string` | `"/icon/aider.svg"` |
45-
| `experiment_report_tasks` | Whether to enable task reporting | `bool` | `true` |
46-
| `experiment_system_prompt` | System prompt to use for Aider AI that includes task reporting instructions | `string` | See default in code |
47-
| `experiment_pre_install_script` | Custom script to run before installing Aider | `string` | `null` |
48-
| `experiment_post_install_script` | Custom script to run after installing Aider | `string` | `null` |
49-
| `experiment_additional_extensions` | Additional extensions configuration in YAML format to append to the config | `string` | `null` |
34+
| Parameter | Description | Type | Default |
35+
| ---------------------------------- | -------------------------------------------------------------------------- | -------- | ------------------- |
36+
| `agent_id` | The ID of a Coder agent (required) | `string` | - |
37+
| `folder` | The folder to run Aider in | `string` | `/home/coder` |
38+
| `install_aider` | Whether to install Aider | `bool` | `true` |
39+
| `aider_version` | The version of Aider to install | `string` | `"latest"` |
40+
| `use_screen` | Whether to use screen for running Aider in the background | `bool` | `true` |
41+
| `use_tmux` | Whether to use tmux instead of screen for running Aider in the background | `bool` | `false` |
42+
| `session_name` | Name for the persistent session (screen or tmux) | `string` | `"aider"` |
43+
| `order` | Position of the app in the UI presentation | `number` | `null` |
44+
| `icon` | The icon to use for the app | `string` | `"/icon/aider.svg"` |
45+
| `experiment_report_tasks` | Whether to enable task reporting | `bool` | `true` |
46+
| `experiment_task_conventions` | Custom conventions for task reporting to be written to CONVENTIONS.md | `string` | See default in code |
47+
| `experiment_pre_install_script` | Custom script to run before installing Aider | `string` | `null` |
48+
| `experiment_post_install_script` | Custom script to run after installing Aider | `string` | `null` |
49+
| `experiment_additional_extensions` | Additional extensions configuration in YAML format to append to the config | `string` | `null` |
5050

5151
## Usage Examples
5252

0 commit comments

Comments
 (0)