fix: apply prettier formatting to AGENTS.md
Fixes CI formatting check failure by applying prettier formatting rules.
This commit is contained in:
parent
2a059af928
commit
135a699edb
23
AGENTS.md
23
AGENTS.md
@ -7,6 +7,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
### Core AI Agents (`coder` namespace)
|
### Core AI Agents (`coder` namespace)
|
||||||
|
|
||||||
#### Aider
|
#### Aider
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder/aider/coder`
|
- **Module**: `registry.coder.com/coder/aider/coder`
|
||||||
- **Description**: AI pair programming tool for editing code in your local git repository
|
- **Description**: AI pair programming tool for editing code in your local git repository
|
||||||
- **Features**: Git-aware code editing, multiple AI provider support, automatic commits
|
- **Features**: Git-aware code editing, multiple AI provider support, automatic commits
|
||||||
@ -15,6 +16,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
- **Documentation**: [View Module](https://registry.coder.com/modules/aider/coder)
|
- **Documentation**: [View Module](https://registry.coder.com/modules/aider/coder)
|
||||||
|
|
||||||
#### Claude Code
|
#### Claude Code
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder/claude-code/coder`
|
- **Module**: `registry.coder.com/coder/claude-code/coder`
|
||||||
- **Description**: Anthropic's Claude AI assistant with subagent support
|
- **Description**: Anthropic's Claude AI assistant with subagent support
|
||||||
- **Features**: Code generation, debugging, specialized subagents for different tasks
|
- **Features**: Code generation, debugging, specialized subagents for different tasks
|
||||||
@ -23,6 +25,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
- **Documentation**: [View Module](https://registry.coder.com/modules/claude-code/coder)
|
- **Documentation**: [View Module](https://registry.coder.com/modules/claude-code/coder)
|
||||||
|
|
||||||
#### Goose
|
#### Goose
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder/goose/coder`
|
- **Module**: `registry.coder.com/coder/goose/coder`
|
||||||
- **Description**: AI-powered development assistant with toolkit integration
|
- **Description**: AI-powered development assistant with toolkit integration
|
||||||
- **Features**: Code analysis, generation, development workflow automation
|
- **Features**: Code analysis, generation, development workflow automation
|
||||||
@ -31,6 +34,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
- **Documentation**: [View Module](https://registry.coder.com/modules/goose/coder)
|
- **Documentation**: [View Module](https://registry.coder.com/modules/goose/coder)
|
||||||
|
|
||||||
#### Amazon Q
|
#### Amazon Q
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder/amazon-q/coder`
|
- **Module**: `registry.coder.com/coder/amazon-q/coder`
|
||||||
- **Description**: Amazon's AI coding assistant with AWS integration
|
- **Description**: Amazon's AI coding assistant with AWS integration
|
||||||
- **Features**: AWS-integrated development, MCP support, comprehensive CLI integration
|
- **Features**: AWS-integrated development, MCP support, comprehensive CLI integration
|
||||||
@ -39,6 +43,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
- **Documentation**: [View Module](https://registry.coder.com/modules/amazon-q/coder)
|
- **Documentation**: [View Module](https://registry.coder.com/modules/amazon-q/coder)
|
||||||
|
|
||||||
#### Cursor IDE
|
#### Cursor IDE
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder/cursor/coder`
|
- **Module**: `registry.coder.com/coder/cursor/coder`
|
||||||
- **Description**: Launch Cursor IDE with AI-powered development features
|
- **Description**: Launch Cursor IDE with AI-powered development features
|
||||||
- **Features**: One-click IDE launch, folder support, recent workspace access
|
- **Features**: One-click IDE launch, folder support, recent workspace access
|
||||||
@ -49,6 +54,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
### Experimental AI Agents (`coder-labs` namespace)
|
### Experimental AI Agents (`coder-labs` namespace)
|
||||||
|
|
||||||
#### Gemini
|
#### Gemini
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder-labs/gemini/coder-labs`
|
- **Module**: `registry.coder.com/coder-labs/gemini/coder-labs`
|
||||||
- **Description**: Google's Gemini AI model for code assistance
|
- **Description**: Google's Gemini AI model for code assistance
|
||||||
- **Features**: Multi-modal AI assistance, code generation, analysis
|
- **Features**: Multi-modal AI assistance, code generation, analysis
|
||||||
@ -57,6 +63,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
- **Documentation**: [View Module](https://registry.coder.com/modules/gemini/coder-labs)
|
- **Documentation**: [View Module](https://registry.coder.com/modules/gemini/coder-labs)
|
||||||
|
|
||||||
#### OpenAI Codex
|
#### OpenAI Codex
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder-labs/codex/coder-labs`
|
- **Module**: `registry.coder.com/coder-labs/codex/coder-labs`
|
||||||
- **Description**: OpenAI's Codex model for code generation and completion
|
- **Description**: OpenAI's Codex model for code generation and completion
|
||||||
- **Features**: Code completion, generation, natural language to code translation
|
- **Features**: Code completion, generation, natural language to code translation
|
||||||
@ -65,6 +72,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
- **Documentation**: [View Module](https://registry.coder.com/modules/codex/coder-labs)
|
- **Documentation**: [View Module](https://registry.coder.com/modules/codex/coder-labs)
|
||||||
|
|
||||||
#### Sourcegraph Amp
|
#### Sourcegraph Amp
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder-labs/sourcegraph-amp/coder-labs`
|
- **Module**: `registry.coder.com/coder-labs/sourcegraph-amp/coder-labs`
|
||||||
- **Description**: Sourcegraph's AI-powered code search and analysis tool
|
- **Description**: Sourcegraph's AI-powered code search and analysis tool
|
||||||
- **Features**: Code search, analysis, AI-powered development insights
|
- **Features**: Code search, analysis, AI-powered development insights
|
||||||
@ -73,6 +81,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
- **Documentation**: [View Module](https://registry.coder.com/modules/sourcegraph-amp/coder-labs)
|
- **Documentation**: [View Module](https://registry.coder.com/modules/sourcegraph-amp/coder-labs)
|
||||||
|
|
||||||
#### Cursor CLI
|
#### Cursor CLI
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder-labs/cursor-cli/coder-labs`
|
- **Module**: `registry.coder.com/coder-labs/cursor-cli/coder-labs`
|
||||||
- **Description**: Cursor CLI for AI-assisted development
|
- **Description**: Cursor CLI for AI-assisted development
|
||||||
- **Features**: Command-line interface for Cursor's AI capabilities, MCP settings integration
|
- **Features**: Command-line interface for Cursor's AI capabilities, MCP settings integration
|
||||||
@ -81,6 +90,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
- **Documentation**: [View Module](https://registry.coder.com/modules/cursor-cli/coder-labs)
|
- **Documentation**: [View Module](https://registry.coder.com/modules/cursor-cli/coder-labs)
|
||||||
|
|
||||||
#### Auggie
|
#### Auggie
|
||||||
|
|
||||||
- **Module**: `registry.coder.com/coder-labs/auggie/coder-labs`
|
- **Module**: `registry.coder.com/coder-labs/auggie/coder-labs`
|
||||||
- **Description**: AI coding assistant with extensive configuration options
|
- **Description**: AI coding assistant with extensive configuration options
|
||||||
- **Features**: Task automation, MCP server integration, configurable AI models
|
- **Features**: Task automation, MCP server integration, configurable AI models
|
||||||
@ -91,6 +101,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
### Community Modules
|
### Community Modules
|
||||||
|
|
||||||
#### Docker Claude Template
|
#### Docker Claude Template
|
||||||
|
|
||||||
- **Template**: `registry.coder.com/sharkymark/docker-claude/sharkymark`
|
- **Template**: `registry.coder.com/sharkymark/docker-claude/sharkymark`
|
||||||
- **Description**: Docker-based template with Claude integration
|
- **Description**: Docker-based template with Claude integration
|
||||||
- **Type**: Complete workspace template
|
- **Type**: Complete workspace template
|
||||||
@ -99,6 +110,7 @@ The Coder Registry provides Terraform modules for integrating various AI coding
|
|||||||
## Module Features
|
## Module Features
|
||||||
|
|
||||||
### Common Features
|
### Common Features
|
||||||
|
|
||||||
All AI agent modules provide:
|
All AI agent modules provide:
|
||||||
|
|
||||||
- **🚀 One-Click Setup**: Automatic installation and configuration
|
- **🚀 One-Click Setup**: Automatic installation and configuration
|
||||||
@ -109,6 +121,7 @@ All AI agent modules provide:
|
|||||||
- **🧪 Tested**: Full test coverage with Terraform and TypeScript tests
|
- **🧪 Tested**: Full test coverage with Terraform and TypeScript tests
|
||||||
|
|
||||||
### AgentAPI Integration
|
### AgentAPI Integration
|
||||||
|
|
||||||
Modules with AgentAPI support provide:
|
Modules with AgentAPI support provide:
|
||||||
|
|
||||||
- **Interactive Chat**: Web-based chat interface
|
- **Interactive Chat**: Web-based chat interface
|
||||||
@ -120,6 +133,7 @@ Modules with AgentAPI support provide:
|
|||||||
## Usage Patterns
|
## Usage Patterns
|
||||||
|
|
||||||
### Basic Usage
|
### Basic Usage
|
||||||
|
|
||||||
```terraform
|
```terraform
|
||||||
module "ai_agent" {
|
module "ai_agent" {
|
||||||
count = data.coder_workspace.me.start_count
|
count = data.coder_workspace.me.start_count
|
||||||
@ -130,6 +144,7 @@ module "ai_agent" {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### With API Key Configuration
|
### With API Key Configuration
|
||||||
|
|
||||||
```terraform
|
```terraform
|
||||||
variable "ai_api_key" {
|
variable "ai_api_key" {
|
||||||
type = string
|
type = string
|
||||||
@ -147,6 +162,7 @@ module "ai_agent" {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### With Task Prompt Support
|
### With Task Prompt Support
|
||||||
|
|
||||||
```terraform
|
```terraform
|
||||||
data "coder_parameter" "ai_prompt" {
|
data "coder_parameter" "ai_prompt" {
|
||||||
name = "AI Prompt"
|
name = "AI Prompt"
|
||||||
@ -168,6 +184,7 @@ module "ai_agent" {
|
|||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
### Required Modules
|
### Required Modules
|
||||||
|
|
||||||
Most AI agent modules require:
|
Most AI agent modules require:
|
||||||
|
|
||||||
```terraform
|
```terraform
|
||||||
@ -178,6 +195,7 @@ module "coder_login" {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Runtime Dependencies
|
### Runtime Dependencies
|
||||||
|
|
||||||
- **Node.js**: Automatically installed via NVM for npm-based agents
|
- **Node.js**: Automatically installed via NVM for npm-based agents
|
||||||
- **Python**: Required for Python-based agents (aider, goose)
|
- **Python**: Required for Python-based agents (aider, goose)
|
||||||
- **Git**: Required for git-aware agents
|
- **Git**: Required for git-aware agents
|
||||||
@ -186,6 +204,7 @@ module "coder_login" {
|
|||||||
## Configuration Best Practices
|
## Configuration Best Practices
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
||||||
Use `coder_env` resources instead of inline exports:
|
Use `coder_env` resources instead of inline exports:
|
||||||
|
|
||||||
```terraform
|
```terraform
|
||||||
@ -205,6 +224,7 @@ resource "coder_agent" "main" {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### System Prompts
|
### System Prompts
|
||||||
|
|
||||||
Configure system prompts for consistent behavior:
|
Configure system prompts for consistent behavior:
|
||||||
|
|
||||||
```terraform
|
```terraform
|
||||||
@ -220,6 +240,7 @@ resource "coder_env" "system_prompt" {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Namespace Guidelines
|
### Namespace Guidelines
|
||||||
|
|
||||||
- **`coder`**: Stable, production-ready modules maintained by Coder
|
- **`coder`**: Stable, production-ready modules maintained by Coder
|
||||||
- **`coder-labs`**: Experimental modules, may have breaking changes
|
- **`coder-labs`**: Experimental modules, may have breaking changes
|
||||||
- **Community**: Third-party modules, varying maintenance levels
|
- **Community**: Third-party modules, varying maintenance levels
|
||||||
@ -235,6 +256,7 @@ resource "coder_env" "system_prompt" {
|
|||||||
5. **Review**: Follow [contributing guidelines](CONTRIBUTING.md)
|
5. **Review**: Follow [contributing guidelines](CONTRIBUTING.md)
|
||||||
|
|
||||||
### Module Structure
|
### Module Structure
|
||||||
|
|
||||||
```
|
```
|
||||||
registry/<namespace>/modules/<agent>/
|
registry/<namespace>/modules/<agent>/
|
||||||
├── main.tf # Terraform configuration
|
├── main.tf # Terraform configuration
|
||||||
@ -260,6 +282,7 @@ registry/<namespace>/modules/<agent>/
|
|||||||
### Debug Information
|
### Debug Information
|
||||||
|
|
||||||
Module logs are typically located at:
|
Module logs are typically located at:
|
||||||
|
|
||||||
```
|
```
|
||||||
/home/coder/.<module-name>-module/
|
/home/coder/.<module-name>-module/
|
||||||
├── install.log
|
├── install.log
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user