Coder Modules

Coder Registry modules are reusable Terraform components that live under registry/<namespace>/modules/<name>/ and are consumed by templates via module blocks.

Before You Start

Before writing or modifying any code:

1. Understand the request. What tool, integration, or functionality is the module providing? What Coder resources does it need (coder_script, coder_app, coder_env, etc.)? Read the official documentation for the target tool or integration (installation steps, CLI flags, config files, environment variables, ports) so you can implement the module properly without guessing.
2. Research existing modules. Search the registry for similar modules. Read their main.tf to understand patterns, variable conventions, and how they solve similar problems. Avoid duplicating existing functionality.
3. Check the Coder provider docs. Verify that the resources and attributes you plan to use exist in the provider version you're targeting. Use the version-specific docs URL if needed.
4. Clarify before building. If the request is ambiguous (e.g. unclear which Coder resource to use, whether a coder_app vs coder_script is appropriate, what variables to expose, or which namespace to use), ask for clarification rather than guessing. Never assume a namespace; always confirm with the user.
5. Plan the structure. Decide on script organization (root run.sh, scripts/ directory, or inline), what variables to expose, and what tests to write.

Always prefer the proper implementation over a simpler shortcut. Modules are infrastructure that users depend on. Doing less work is not the same as reducing complexity if it leaves the module incomplete or fragile.

Documentation References

Coder