Skip to content

Commit b427fe3

Browse files
committed
docs: Standardize module examples to use coder_agent.main
Update all module README files to use coder_agent.main instead of coder_agent.example for consistency with existing template conventions. Changes: - Updated 50+ module README.md files - Updated root README.md and CONTRIBUTING.md - Updated examples/templates/main.tf This ensures copy-paste examples from module docs work seamlessly with the majority of templates that use "main" as the agent name.
1 parent 7b84d91 commit b427fe3

File tree

52 files changed

+200
-200
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+200
-200
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ module "cursor" {
3939
count = data.coder_workspace.me.start_count
4040
source = "registry.coder.com/coder/cursor/coder"
4141
version = "1.0.19"
42-
agent_id = coder_agent.example.id
42+
agent_id = coder_agent.main.id
4343
}
4444
```
4545

registry/AJ0070/modules/pgadmin/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,6 @@ module "pgadmin" {
1818
count = data.coder_workspace.me.start_count
1919
source = "registry.coder.com/AJ0070/pgadmin/coder"
2020
version = "1.0.0"
21-
agent_id = coder_agent.example.id
21+
agent_id = coder_agent.main.id
2222
}
2323
```

registry/BenraouaneSoufiane/modules/rustdesk/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ module "rustdesk" {
1515
count = data.coder_workspace.me.start_count
1616
source = "registry.coder.com/BenraouaneSoufiane/rustdesk/coder"
1717
version = "1.0.0"
18-
agent_id = coder_agent.example.id
18+
agent_id = coder_agent.main.id
1919
}
2020
```
2121

@@ -42,7 +42,7 @@ module "rustdesk" {
4242
count = data.coder_workspace.me.start_count
4343
source = "registry.coder.com/BenraouaneSoufiane/rustdesk/coder"
4444
version = "1.0.0"
45-
agent_id = coder_agent.example.id
45+
agent_id = coder_agent.main.id
4646
rustdesk_password = "mycustompass"
4747
xvfb_resolution = "1920x1080x24"
4848
rustdesk_version = "1.4.1"

registry/anomaly/modules/tmux/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ up a default or custom tmux configuration with session save/restore capabilities
1616
module "tmux" {
1717
source = "registry.coder.com/anomaly/tmux/coder"
1818
version = "1.0.1"
19-
agent_id = coder_agent.example.id
19+
agent_id = coder_agent.main.id
2020
}
2121
```
2222

@@ -40,7 +40,7 @@ module "tmux" {
4040
module "tmux" {
4141
source = "registry.coder.com/anomaly/tmux/coder"
4242
version = "1.0.1"
43-
agent_id = coder_agent.example.id
43+
agent_id = coder_agent.main.id
4444
tmux_config = "" # Optional: custom tmux.conf content
4545
save_interval = 1 # Optional: save interval in minutes
4646
sessions = ["default", "dev", "ops"] # Optional: list of tmux sessions

registry/coder-labs/modules/archive/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ module "archive" {
1515
count = data.coder_workspace.me.start_count
1616
source = "registry.coder.com/coder-labs/archive/coder"
1717
version = "0.0.1"
18-
agent_id = coder_agent.example.id
18+
agent_id = coder_agent.main.id
1919
2020
paths = ["./projects", "./code"]
2121
}
@@ -44,7 +44,7 @@ module "archive" {
4444
count = data.coder_workspace.me.start_count
4545
source = "registry.coder.com/coder-labs/archive/coder"
4646
version = "0.0.1"
47-
agent_id = coder_agent.example.id
47+
agent_id = coder_agent.main.id
4848
4949
# Paths to include in the archive (files or directories).
5050
directory = "~"
@@ -62,7 +62,7 @@ module "archive" {
6262
count = data.coder_workspace.me.start_count
6363
source = "registry.coder.com/coder-labs/archive/coder"
6464
version = "0.0.1"
65-
agent_id = coder_agent.example.id
65+
agent_id = coder_agent.main.id
6666
6767
directory = "/"
6868
paths = ["/etc", "/home"]
@@ -79,7 +79,7 @@ module "archive" {
7979
count = data.coder_workspace.me.start_count
8080
source = "registry.coder.com/coder-labs/archive/coder"
8181
version = "0.0.1"
82-
agent_id = coder_agent.example.id
82+
agent_id = coder_agent.main.id
8383
8484
# Creates /tmp/coder-archive.tar.gz of the users home directory (defaults).
8585
create_on_stop = true
@@ -93,7 +93,7 @@ module "archive" {
9393
count = data.coder_workspace.me.start_count
9494
source = "registry.coder.com/coder-labs/archive/coder"
9595
version = "0.0.1"
96-
agent_id = coder_agent.example.id
96+
agent_id = coder_agent.main.id
9797
9898
# Where to look for the archive file to extract:
9999
output_dir = "/tmp"

registry/coder-labs/modules/auggie/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Run Auggie CLI in your workspace to access Augment's AI coding assistant with ad
1414
module "auggie" {
1515
source = "registry.coder.com/coder-labs/auggie/coder"
1616
version = "0.2.1"
17-
agent_id = coder_agent.example.id
17+
agent_id = coder_agent.main.id
1818
folder = "/home/coder/project"
1919
}
2020
```
@@ -42,13 +42,13 @@ module "coder-login" {
4242
count = data.coder_workspace.me.start_count
4343
source = "registry.coder.com/coder/coder-login/coder"
4444
version = "1.0.31"
45-
agent_id = coder_agent.example.id
45+
agent_id = coder_agent.main.id
4646
}
4747
4848
module "auggie" {
4949
source = "registry.coder.com/coder-labs/auggie/coder"
5050
version = "0.2.1"
51-
agent_id = coder_agent.example.id
51+
agent_id = coder_agent.main.id
5252
folder = "/home/coder/project"
5353
5454
# Authentication
@@ -104,7 +104,7 @@ EOF
104104
module "auggie" {
105105
source = "registry.coder.com/coder-labs/auggie/coder"
106106
version = "0.2.1"
107-
agent_id = coder_agent.example.id
107+
agent_id = coder_agent.main.id
108108
folder = "/home/coder/project"
109109
110110
# Multiple MCP configuration files

registry/coder-labs/modules/codex/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Run Codex CLI in your workspace to access OpenAI's models through the Codex inte
1414
module "codex" {
1515
source = "registry.coder.com/coder-labs/codex/coder"
1616
version = "3.1.0"
17-
agent_id = coder_agent.example.id
17+
agent_id = coder_agent.main.id
1818
openai_api_key = var.openai_api_key
1919
workdir = "/home/coder/project"
2020
}
@@ -34,7 +34,7 @@ module "codex" {
3434
count = data.coder_workspace.me.start_count
3535
source = "registry.coder.com/coder-labs/codex/coder"
3636
version = "3.1.0"
37-
agent_id = coder_agent.example.id
37+
agent_id = coder_agent.main.id
3838
openai_api_key = "..."
3939
workdir = "/home/coder/project"
4040
report_tasks = false
@@ -56,13 +56,13 @@ module "coder-login" {
5656
count = data.coder_workspace.me.start_count
5757
source = "registry.coder.com/coder/coder-login/coder"
5858
version = "1.0.31"
59-
agent_id = coder_agent.example.id
59+
agent_id = coder_agent.main.id
6060
}
6161
6262
module "codex" {
6363
source = "registry.coder.com/coder-labs/codex/coder"
6464
version = "3.1.0"
65-
agent_id = coder_agent.example.id
65+
agent_id = coder_agent.main.id
6666
openai_api_key = "..."
6767
ai_prompt = data.coder_parameter.ai_prompt.value
6868
workdir = "/home/coder/project"

registry/coder-labs/modules/copilot/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Run [GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-c
1414
module "copilot" {
1515
source = "registry.coder.com/coder-labs/copilot/coder"
1616
version = "0.2.2"
17-
agent_id = coder_agent.example.id
17+
agent_id = coder_agent.main.id
1818
workdir = "/home/coder/projects"
1919
}
2020
```
@@ -52,7 +52,7 @@ data "coder_parameter" "ai_prompt" {
5252
module "copilot" {
5353
source = "registry.coder.com/coder-labs/copilot/coder"
5454
version = "0.2.2"
55-
agent_id = coder_agent.example.id
55+
agent_id = coder_agent.main.id
5656
workdir = "/home/coder/projects"
5757
5858
ai_prompt = data.coder_parameter.ai_prompt.value
@@ -72,7 +72,7 @@ Customize tool permissions, MCP servers, and Copilot settings:
7272
module "copilot" {
7373
source = "registry.coder.com/coder-labs/copilot/coder"
7474
version = "0.2.2"
75-
agent_id = coder_agent.example.id
75+
agent_id = coder_agent.main.id
7676
workdir = "/home/coder/projects"
7777
7878
# Version pinning (defaults to "latest", use specific version if desired)
@@ -143,7 +143,7 @@ variable "github_token" {
143143
module "copilot" {
144144
source = "registry.coder.com/coder-labs/copilot/coder"
145145
version = "0.2.2"
146-
agent_id = coder_agent.example.id
146+
agent_id = coder_agent.main.id
147147
workdir = "/home/coder/projects"
148148
github_token = var.github_token
149149
}
@@ -157,7 +157,7 @@ Run Copilot as a command-line tool without task reporting or web interface. This
157157
module "copilot" {
158158
source = "registry.coder.com/coder-labs/copilot/coder"
159159
version = "0.2.2"
160-
agent_id = coder_agent.example.id
160+
agent_id = coder_agent.main.id
161161
workdir = "/home/coder"
162162
report_tasks = false
163163
cli_app = true

registry/coder-labs/modules/cursor-cli/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Run the Cursor Agent CLI in your workspace for interactive coding assistance and
1414
module "cursor_cli" {
1515
source = "registry.coder.com/coder-labs/cursor-cli/coder"
1616
version = "0.2.1"
17-
agent_id = coder_agent.example.id
17+
agent_id = coder_agent.main.id
1818
folder = "/home/coder/project"
1919
}
2020
```
@@ -43,7 +43,7 @@ module "coder-login" {
4343
module "cursor_cli" {
4444
source = "registry.coder.com/coder-labs/cursor-cli/coder"
4545
version = "0.2.1"
46-
agent_id = coder_agent.example.id
46+
agent_id = coder_agent.main.id
4747
folder = "/home/coder/project"
4848
4949
# Optional

registry/coder-labs/modules/gemini/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Run [Gemini CLI](https://github.com/google-gemini/gemini-cli) in your workspace
1414
module "gemini" {
1515
source = "registry.coder.com/coder-labs/gemini/coder"
1616
version = "2.1.1"
17-
agent_id = coder_agent.example.id
17+
agent_id = coder_agent.main.id
1818
folder = "/home/coder/project"
1919
}
2020
```
@@ -47,7 +47,7 @@ variable "gemini_api_key" {
4747
module "gemini" {
4848
source = "registry.coder.com/coder-labs/gemini/coder"
4949
version = "2.1.1"
50-
agent_id = coder_agent.example.id
50+
agent_id = coder_agent.main.id
5151
gemini_api_key = var.gemini_api_key
5252
folder = "/home/coder/project"
5353
}
@@ -80,7 +80,7 @@ module "coder-login" {
8080
count = data.coder_workspace.me.start_count
8181
source = "registry.coder.com/coder/coder-login/coder"
8282
version = "~> 1.0"
83-
agent_id = coder_agent.example.id
83+
agent_id = coder_agent.main.id
8484
}
8585
8686
data "coder_parameter" "ai_prompt" {
@@ -95,7 +95,7 @@ module "gemini" {
9595
count = data.coder_workspace.me.start_count
9696
source = "registry.coder.com/coder-labs/gemini/coder"
9797
version = "2.1.1"
98-
agent_id = coder_agent.example.id
98+
agent_id = coder_agent.main.id
9999
gemini_api_key = var.gemini_api_key
100100
gemini_model = "gemini-2.5-flash"
101101
folder = "/home/coder/project"
@@ -119,7 +119,7 @@ For enterprise users who prefer Google's Vertex AI platform:
119119
module "gemini" {
120120
source = "registry.coder.com/coder-labs/gemini/coder"
121121
version = "2.1.1"
122-
agent_id = coder_agent.example.id
122+
agent_id = coder_agent.main.id
123123
gemini_api_key = var.gemini_api_key
124124
folder = "/home/coder/project"
125125
use_vertexai = true

0 commit comments

Comments
 (0)