docs(aider): update README.md to enhance API integration details

DevelopmentCats · DevelopmentCats · commit 639662fe984a · 2025-05-15T13:28:16.000Z
## Changes made
- Updated non-interactive mode description to use `task_prompt` variable
- Added new parameters for AI provider, model, and API key configuration
- Revised usage examples to include OpenAI and custom provider setups
- Enhanced task reporting instructions and system prompt customization
- Clarified available AI providers and models with default settings
diff --git a/registry/coder/modules/aider/README.md b/registry/coder/modules/aider/README.md
@@ -27,7 +27,7 @@ module "aider" {
 - **Optional Dependencies**: Install Playwright for web page scraping and PortAudio for voice coding
 - **Project Integration**: Works with any project directory, including Git repositories
 - **Browser UI**: Use Aider in your browser with a modern web interface instead of the terminal
-- **Non-Interactive Mode**: Automatically processes tasks when provided via the `CODER_MCP_AIDER_TASK_PROMPT` environment variable
+- **Non-Interactive Mode**: Automatically processes tasks when provided via the `task_prompt` variable
 
 ## Module Parameters
 
@@ -43,7 +43,12 @@ module "aider" {
 | `order`                            | Position of the app in the UI presentation                                 | `number` | `null`              |
 | `icon`                             | The icon to use for the app                                                | `string` | `"/icon/aider.svg"` |
 | `experiment_report_tasks`          | Whether to enable task reporting                                           | `bool`   | `true`              |
-| `experiment_task_conventions`      | Custom conventions for task reporting to be written to CONVENTIONS.md      | `string` | See default in code |
+| `system_prompt`                    | System prompt for instructing Aider on task reporting and behavior         | `string` | See default in code |
+| `task_prompt`                      | Task prompt to use with Aider                                             | `string` | `""`                |
+| `ai_provider`                      | AI provider to use with Aider (openai, anthropic, azure, etc.)             | `string` | `"anthropic"`       |
+| `ai_model`                         | AI model to use (can use Aider's built-in aliases like "sonnet", "4o")     | `string` | `"sonnet"`          |
+| `ai_api_key`                       | API key for the selected AI provider                                       | `string` | `""`                |
+| `custom_env_var_name`              | Custom environment variable name when using custom provider                | `string` | `""`                |
 | `experiment_pre_install_script`    | Custom script to run before installing Aider                               | `string` | `null`              |
 | `experiment_post_install_script`   | Custom script to run after installing Aider                                | `string` | `null`              |
 | `experiment_additional_extensions` | Additional extensions configuration in YAML format to append to the config | `string` | `null`              |
@@ -52,75 +57,70 @@ module "aider" {
 
 ## Usage Examples
 
-### Basic setup
+### Basic setup with API key
 
 ```tf
+variable "anthropic_api_key" {
+  type        = string
+  description = "Anthropic API key"
+  sensitive   = true
+}
+
 module "aider" {
-  count    = data.coder_workspace.me.start_count
-  source   = "registry.coder.com/modules/aider/coder"
-  version  = "1.0.0"
-  agent_id = coder_agent.example.id
-  folder   = "/home/coder"
+  count      = data.coder_workspace.me.start_count
+  source     = "registry.coder.com/modules/aider/coder"
+  version    = "1.0.0"
+  agent_id   = coder_agent.example.id
+  ai_api_key = var.anthropic_api_key
 }
 ```
 
 This basic setup will:
 
 - Install Aider in the workspace
 - Create a persistent screen session named "aider"
+- Configure Aider to use Anthropic Claude 3.7 Sonnet model
 - Enable task reporting (configures Aider to report tasks to Coder MCP)
 
-### With tmux instead of screen
+### Using OpenAI with tmux
 
 ```tf
+variable "openai_api_key" {
+  type        = string
+  description = "OpenAI API key"
+  sensitive   = true
+}
+
 module "aider" {
-  count    = data.coder_workspace.me.start_count
-  source   = "registry.coder.com/modules/aider/coder"
-  version  = "1.0.0"
-  agent_id = coder_agent.example.id
-  folder   = "/home/coder"
-  use_tmux = true
+  count       = data.coder_workspace.me.start_count
+  source      = "registry.coder.com/modules/aider/coder"
+  version     = "1.0.0"
+  agent_id    = coder_agent.example.id
+  use_tmux    = true
+  ai_provider = "openai"
+  ai_model    = "4o"   # Uses Aider's built-in alias for gpt-4o
+  ai_api_key  = var.openai_api_key
 }
 ```
 
-### With API key via environment variables
+### Using a custom provider
 
 ```tf
-variable "anthropic_api_key" {
+variable "custom_api_key" {
   type        = string
-  description = "Anthropic API key"
+  description = "Custom provider API key"
   sensitive   = true
 }
 
-variable "anthropic_model" {
-  type        = string
-  description = "Anthropic Model"
-  default     = "sonnet"
-}
-
-resource "coder_agent" "main" {
-  # ...
-}
-
-# Set API key and model using coder_env resource
-resource "coder_env" "anthropic" {
-  agent_id = coder_agent.example.id
-  name     = "ANTHROPIC_API_KEY"
-  value    = var.anthropic_api_key
-}
-
-resource "coder_env" "aider_model" {
-  agent_id = coder_agent.example.id
-  name     = "AIDER_MODEL"
-  value    = var.anthropic_model
-}
-
 module "aider" {
-  count    = data.coder_workspace.me.start_count
-  source   = "registry.coder.com/modules/aider/coder"
-  version  = "1.0.0"
-  agent_id = coder_agent.example.id
-  folder   = "/home/coder"
+  count              = data.coder_workspace.me.start_count
+  source             = "registry.coder.com/modules/aider/coder"
+  version            = "1.0.0"
+  agent_id           = coder_agent.example.id
+  ai_provider        = "custom"
+  custom_env_var_name = "MY_CUSTOM_API_KEY"
+  ai_model           = "custom-model" 
+  ai_api_key         = var.custom_api_key
 }
 ```
 
@@ -130,11 +130,11 @@ You can extend Aider's capabilities by adding custom extensions:
 
 ```tf
 module "aider" {
-  count    = data.coder_workspace.me.start_count
-  source   = "registry.coder.com/modules/aider/coder"
-  version  = "1.0.0"
-  agent_id = coder_agent.example.id
-  folder   = "/home/coder"
+  count      = data.coder_workspace.me.start_count
+  source     = "registry.coder.com/modules/aider/coder"
+  version    = "1.0.0"
+  agent_id   = coder_agent.example.id
+  ai_api_key = var.anthropic_api_key
 
   experiment_pre_install_script = <<-EOT
   pip install some-custom-dependency
@@ -180,7 +180,7 @@ Task reporting is **enabled by default** in this module, allowing you to:
 To use task reporting effectively:
 
 1. Add the Coder Login module to your template
-2. Configure the necessary environment variables to pass the task prompt and status slug
+2. Configure the necessary variables to pass the task prompt
 3. Optionally add a coder_parameter to collect prompts from users
 
 Here's a complete example:
@@ -199,12 +199,6 @@ variable "anthropic_api_key" {
   sensitive   = true
 }
 
-variable "anthropic_model" {
-  type        = string
-  description = "Anthropic Model"
-  default     = "sonnet"
-}
-
 data "coder_parameter" "ai_prompt" {
   type        = "string"
   name        = "AI Prompt"
@@ -214,44 +208,48 @@ data "coder_parameter" "ai_prompt" {
   ephemeral   = true
 }
 
-# Configure environment variables for API key, model and task prompt
-resource "coder_env" "anthropic" {
-  agent_id = coder_agent.example.id
-  name     = "ANTHROPIC_API_KEY"
-  value    = var.anthropic_api_key
-}
-
-resource "coder_env" "aider_model" {
-  agent_id = coder_agent.example.id
-  name     = "AIDER_MODEL"
-  value    = var.anthropic_model
+module "aider" {
+  count       = data.coder_workspace.me.start_count
+  source      = "registry.coder.com/modules/aider/coder"
+  version     = "1.0.0"
+  agent_id    = coder_agent.example.id
+  ai_api_key  = var.anthropic_api_key
+  task_prompt = data.coder_parameter.ai_prompt.value
+
+  # Optionally customize the system prompt
+  system_prompt = <<-EOT
+You are a helpful Coding assistant. Aim to autonomously investigate
+and solve issues the user gives you and test your work, whenever possible.
+Avoid shortcuts like mocking tests. When you get stuck, you can ask the user
+but opt for autonomy.
+YOU MUST REPORT ALL TASKS TO CODER.
+When reporting tasks, you MUST follow these EXACT instructions:
+- IMMEDIATELY report status after receiving ANY user message.
+- Be granular. If you are investigating with multiple steps, report each step to coder.
+Task state MUST be one of the following:
+- Use "state": "working" when actively processing WITHOUT needing additional user input.
+- Use "state": "complete" only when finished with a task.
+- Use "state": "failure" when you need ANY user input, lack sufficient details, or encounter blockers.
+Task summaries MUST:
+- Include specifics about what you're doing.
+- Include clear and actionable steps for the user.
+- Be less than 160 characters in length.
+  EOT
 }
+```
 
-resource "coder_env" "task_prompt" {
-  agent_id = coder_agent.example.id
-  name     = "CODER_MCP_AIDER_TASK_PROMPT"
-  value    = data.coder_parameter.ai_prompt.value
-}
+When a task prompt is provided via the `task_prompt` variable, the module automatically:
 
-resource "coder_env" "app_status" {
-  agent_id = coder_agent.example.id
-  name     = "CODER_MCP_APP_STATUS_SLUG"
-  value    = "aider"
-}
+1. Combines the system prompt with the task prompt into a single message in the format:
 
-module "aider" {
-  count    = data.coder_workspace.me.start_count
-  source   = "registry.coder.com/modules/aider/coder"
-  version  = "1.0.0"
-  agent_id = coder_agent.example.id
-  folder   = "/home/coder"
-}
 ```
+SYSTEM PROMPT:
+[system_prompt content]
 
-When a task prompt is provided, the module automatically:
+This is your current task: [task_prompt]
+```
 
-1. Executes the task during workspace creation using the `--message` and `--yes-always` flags
-2. Creates a flag file to prevent duplicate execution if the Aider button is clicked later
+2. Executes the task during workspace creation using the `--message` and `--yes-always` flags
 3. Logs task output to `$HOME/.aider.log` for reference
 
 If you want to disable task reporting, set `experiment_report_tasks = false` in your module configuration.
@@ -266,16 +264,18 @@ You can run Aider in three different ways:
 
 1. **Direct Mode**: Aider starts directly in the specified folder when you click the app button
 
-   - Simple setup without persistent context
-   - Suitable for quick coding sessions
+- Simple setup without persistent context
+- Suitable for quick coding sessions
 
 2. **Screen Mode** (Default): Run Aider in a screen session that persists across connections
 
-   - Session name: "aider" (or configured via `session_name`)
+- Session name: "aider" (or configured via `session_name`)
 
 3. **Tmux Mode**: Run Aider in a tmux session instead of screen
-   - Set `use_tmux = true` to enable
-   - Session name: "aider" (or configured via `session_name`)
+
+- Set `use_tmux = true` to enable
+- Session name: "aider" (or configured via `session_name`)
+- Configures tmux with mouse support for shared sessions
 
 Persistent sessions (screen/tmux) allow you to:
 
@@ -285,15 +285,20 @@ Persistent sessions (screen/tmux) allow you to:
 
 ### Available AI Providers and Models
 
-| Provider       | Available Models                    | API Key Source                                              |
-| -------------- | ----------------------------------- | ----------------------------------------------------------- |
-| **Anthropic**  | Claude 3.7 Sonnet, Claude 3.7 Haiku | [console.anthropic.com](https://console.anthropic.com/)     |
-| **OpenAI**     | o3-mini, o1, GPT-4o                 | [platform.openai.com](https://platform.openai.com/api-keys) |
-| **DeepSeek**   | DeepSeek R1, DeepSeek Chat V3       | [platform.deepseek.com](https://platform.deepseek.com/)     |
-| **GROQ**       | Mixtral, Llama 3                    | [console.groq.com](https://console.groq.com/keys)           |
-| **OpenRouter** | OpenRouter                          | [openrouter.ai](https://openrouter.ai/keys)                 |
+Aider supports various providers and models, and this module integrates directly with Aider's built-in model aliases:
+
+| Provider       | Example Models/Aliases                      | Default Model     |
+| -------------- | ------------------------------------------- | ----------------- |
+| **anthropic**  | "sonnet" (Claude 3.7 Sonnet), "opus", "haiku" | "sonnet"        |
+| **openai**     | "4o" (GPT-4o), "4" (GPT-4), "3.5-turbo"      | "4o"            |
+| **azure**      | Azure OpenAI models                         | "gpt-4"          |
+| **google**     | "gemini" (Gemini Pro), "gemini-2.5-pro"     | "gemini-2.5-pro" |
+| **cohere**     | "command-r-plus", etc.                      | "command-r-plus" |
+| **mistral**    | "mistral-large-latest"                      | "mistral-large-latest" |
+| **ollama**     | "llama3", etc.                              | "llama3"         |
+| **custom**     | Any model name with custom ENV variable     | -                |
 
-For a complete and up-to-date list of supported LLMs and models, please refer to the [Aider LLM documentation](https://aider.chat/docs/llms.html) and the [Aider LLM Leaderboards](https://aider.chat/docs/leaderboards.html) which show performance comparisons across different models.
+For a complete and up-to-date list of supported aliases and models, please refer to the [Aider LLM documentation](https://aider.chat/docs/llms.html) and the [Aider LLM Leaderboards](https://aider.chat/docs/leaderboards.html) which show performance comparisons across different models.
 
 ## Troubleshooting
 
@@ -304,3 +309,5 @@ If you encounter issues:
 3. **Browser mode issues**: If the browser interface doesn't open, check that you're accessing it from a machine that can reach your Coder workspace
 
 For more information on using Aider, see the [Aider documentation](https://aider.chat/docs/).
+
+```
