Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit b531be1

Browse files
DevelopmentCatsDevelopmentCats
committed
docs(modules): expand module types section with examples for IDE, Helper, Desktop, AI, Integration, and Web-based Tools and remove duplicate explanation from end of doc.
1 parent 3379347 commit b531be1

File tree

1 file changed

+65
-26
lines changed

1 file changed

+65
-26
lines changed

‎docs/about/contributing/modules.md

Lines changed: 65 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,71 @@ flowchart LR
9494

9595
**Example Flow**: A template references the `code-server` module → Module adds a `coder_script` to install VS Code and a `coder_app` for browser access → Agent executes the script and serves the app → Developer gets VS Code in their workspace
9696

97+
## Module Types and Examples
98+
99+
The Coder Registry organizes modules into different categories based on their functionality. Here are the main types with examples of actual available modules:
100+
101+
### [IDE Modules](https://registry.coder.com/modules?search=tag%3Aide)
102+
Integrate development environments and code editors into workspaces.
103+
104+
- **code-server**: VS Code in the browser
105+
- **Cursor IDE**: Add a one-click button to launch Cursor IDE
106+
- **JetBrains Gateway**: Add a one-click button to launch JetBrains Gateway IDEs in the dashboard
107+
- **Jupyter Notebook**: A module that adds Jupyter Notebook in your Coder template
108+
- **JupyterLab**: A module that adds JupyterLab in your Coder template
109+
- **VS Code Desktop**: Add a one-click button to launch VS Code Desktop
110+
- **VS Code Web**: VS Code Web - Visual Studio Code in the browser
111+
- **Windsurf Editor**: Add a one-click button to launch Windsurf Editor
112+
113+
### [Helper Modules](https://registry.coder.com/modules?search=tag%3Ahelper)
114+
Simplify template creation and workspace configuration.
115+
116+
- **AWS Region**: A parameter with human region names and icons
117+
- **Azure Region**: A parameter with human region names and icons
118+
- **Coder Login**: Automatically logs the user into Coder on their workspace
119+
- **Dotfiles**: Allow developers to optionally bring their own dotfiles repository to customize their shell and IDE settings
120+
- **Fly.io Region**: A parameter with human region names and icons
121+
- **GCP Region**: Add Google Cloud Platform regions to your Coder template
122+
- **Git Clone**: Clone a Git repository by URL and skip if it exists
123+
- **Git commit signing**: Configures Git to sign commits using your Coder SSH key
124+
- **Git Config**: Stores Git configuration from Coder credentials
125+
- **Github Upload Public Key**: Automates uploading Coder public key to Github so users don't have to
126+
- **Personalize**: Allow developers to customize their workspace on start
127+
- **Slack Me**: Send a Slack message when a command finishes inside a workspace
128+
129+
### [Desktop Modules](https://registry.coder.com/modules?search=tag%3Adesktop)
130+
Provide graphical desktop environments for visual development workflows.
131+
132+
- **Amazon DCV Windows**: Amazon DCV Server and Web Client for Windows
133+
- **KasmVNC**: A modern open source VNC server
134+
- **Windows RDP**: RDP Server and Web Client, powered by Devolutions Gateway
135+
- **Windows RDP Desktop**: Enable RDP on Windows and add a one-click Coder Desktop button for seamless access
136+
137+
### [AI Modules](https://registry.coder.com/modules?search=tag%3Aai)
138+
Integrate AI-powered development tools and assistants.
139+
140+
- **Aider**: Run Aider AI pair programming in your workspace
141+
- **Amazon Q**: Run Amazon Q in your workspace to access Amazon's AI coding assistant
142+
- **Claude Code**: Run Claude Code in your workspace
143+
- **Goose**: Run Goose in your workspace
144+
145+
### [Integration Modules](https://registry.coder.com/modules?search=tag%3Aintegration)
146+
Connect with external services and platforms.
147+
148+
- **Hashicorp Vault Integration (GitHub)**: Authenticates with Vault using GitHub
149+
- **Hashicorp Vault Integration (JWT)**: Authenticates with Vault using a JWT from Coder's OIDC provider
150+
- **Hashicorp Vault Integration (Token)**: Authenticates with Vault using Token
151+
- **HCP Vault Secrets**: Fetch secrets from HCP Vault
152+
- **JFrog (OAuth)**: Install the JF CLI and authenticate with Artifactory using OAuth
153+
- **JFrog (Token)**: Install the JF CLI and authenticate with Artifactory using Artifactory terraform provider
154+
155+
### [Web-based Tools](https://registry.coder.com/modules?search=tag%3Aweb)
156+
Browser-accessible applications and interfaces.
157+
158+
- **File Browser**: A file browser for your workspace
159+
160+
Browse all available modules and explore specific categories at [registry.coder.com](https://registry.coder.com).
161+
97162
## Module Integration
98163

99164
```tf
@@ -400,32 +465,6 @@ Every module requires a `README.md` with YAML frontmatter containing metadata li
400465

401466
The documentation format is validated automatically and must pass validation before modules can be accepted. See the [Registry Contributing Guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md) for detailed formatting requirements and examples.
402467

403-
## Common Use Case Patterns
404-
405-
### External IDE Integration
406-
407-
**Browser-based IDE Pattern**: Install web-based development environment with health monitoring and configuration management.
408-
409-
**Desktop IDE Pattern**: Provide protocol-based integration for native applications with backend service management.
410-
411-
**Editor Extension Pattern**: Configure existing editors with workspace-specific settings and extensions.
412-
413-
### Authentication and Secrets
414-
415-
**OAuth Integration Pattern**: Handle external authentication flows with token management and service configuration.
416-
417-
**API Key Management Pattern**: Securely distribute credentials and configure authenticated tools.
418-
419-
**Certificate Management Pattern**: Handle SSL certificates and secure communication setup.
420-
421-
### Development Environment Setup
422-
423-
**Language Runtime Pattern**: Install and configure programming language environments with package managers.
424-
425-
**Database Service Pattern**: Deploy and configure database services with connection management.
426-
427-
**Configuration Management Pattern**: Apply dotfiles, settings, and workspace personalization.
428-
429468
## Contributing to the Registry
430469

431470
The [Coder Registry](https://github.com/coder/registry) hosts all community and official modules. For detailed contribution guidelines, code standards, and submission processes, refer to the [Registry Contributing Guide](https://github.com/coder/registry/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)