Skip to content

Commit 4238f38

Browse files
35C4n0rmatifaliDevelopmentCats
authored
fix: reformat cursor cli readme (#336)
Closes # ## Description <!-- Briefly describe what this PR does and why --> ## Type of Change - [ ] New module - [ ] Bug fix - [ ] Feature/enhancement - [x] Documentation - [ ] Other ## Module Information <!-- Delete this section if not applicable --> **Path:** `registry/[namespace]/modules/[module-name]` **New version:** `v1.0.0` **Breaking change:** [ ] Yes [ ] No ## Testing & Validation - [x] Tests pass (`bun test`) - [x] Code formatted (`bun run fmt`) - [x] Changes tested locally ## Related Issues <!-- Link related issues or write "None" if not applicable --> --------- Co-authored-by: Atif Ali <[email protected]> Co-authored-by: DevCats <[email protected]>
1 parent 858799c commit 4238f38

File tree

1 file changed

+16
-4
lines changed
  • registry/coder-labs/modules/cursor-cli

1 file changed

+16
-4
lines changed

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

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
11
---
22
display_name: Cursor CLI
33
icon: ../../../../.icons/cursor.svg
4-
description: Run Cursor CLI agent in your workspace (no AgentAPI)
4+
description: Run Cursor Agent CLI in your workspace for AI pair programming
55
verified: true
6-
tags: [agent, cursor, ai, cli]
6+
tags: [agent, cursor, ai, tasks]
77
---
88

99
# Cursor CLI
1010

11-
Run the Cursor Coding Agent in your workspace using the Cursor CLI directly.
11+
Run the Cursor Agent CLI in your workspace for interactive coding assistance and automated task execution.
12+
13+
```tf
14+
module "cursor_cli" {
15+
source = "registry.coder.com/coder-labs/cursor-cli/coder"
16+
version = "0.1.1"
17+
agent_id = coder_agent.example.id
18+
folder = "/home/coder/project"
19+
}
20+
```
21+
22+
## Basic setup
1223

1324
A full example with MCP, rules, and pre/post install scripts:
1425

@@ -31,7 +42,7 @@ module "coder-login" {
3142
3243
module "cursor_cli" {
3344
source = "registry.coder.com/coder-labs/cursor-cli/coder"
34-
version = "0.1.0"
45+
version = "0.1.1"
3546
agent_id = coder_agent.example.id
3647
folder = "/home/coder/project"
3748
@@ -40,6 +51,7 @@ module "cursor_cli" {
4051
force = true
4152
model = "gpt-5"
4253
ai_prompt = data.coder_parameter.ai_prompt.value
54+
api_key = "xxxx-xxxx-xxxx" # Required while using tasks, see note below
4355
4456
# Minimal MCP server (writes `folder/.cursor/mcp.json`):
4557
mcp = jsonencode({

0 commit comments

Comments
 (0)