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 <me@matifali.dev> Co-authored-by: DevCats <christofer@coder.com>
This commit is contained in:
parent
858799ce20
commit
4238f38353
@ -1,14 +1,25 @@
|
|||||||
---
|
---
|
||||||
display_name: Cursor CLI
|
display_name: Cursor CLI
|
||||||
icon: ../../../../.icons/cursor.svg
|
icon: ../../../../.icons/cursor.svg
|
||||||
description: Run Cursor CLI agent in your workspace (no AgentAPI)
|
description: Run Cursor Agent CLI in your workspace for AI pair programming
|
||||||
verified: true
|
verified: true
|
||||||
tags: [agent, cursor, ai, cli]
|
tags: [agent, cursor, ai, tasks]
|
||||||
---
|
---
|
||||||
|
|
||||||
# Cursor CLI
|
# Cursor CLI
|
||||||
|
|
||||||
Run the Cursor Coding Agent in your workspace using the Cursor CLI directly.
|
Run the Cursor Agent CLI in your workspace for interactive coding assistance and automated task execution.
|
||||||
|
|
||||||
|
```tf
|
||||||
|
module "cursor_cli" {
|
||||||
|
source = "registry.coder.com/coder-labs/cursor-cli/coder"
|
||||||
|
version = "0.1.1"
|
||||||
|
agent_id = coder_agent.example.id
|
||||||
|
folder = "/home/coder/project"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Basic setup
|
||||||
|
|
||||||
A full example with MCP, rules, and pre/post install scripts:
|
A full example with MCP, rules, and pre/post install scripts:
|
||||||
|
|
||||||
@ -31,7 +42,7 @@ module "coder-login" {
|
|||||||
|
|
||||||
module "cursor_cli" {
|
module "cursor_cli" {
|
||||||
source = "registry.coder.com/coder-labs/cursor-cli/coder"
|
source = "registry.coder.com/coder-labs/cursor-cli/coder"
|
||||||
version = "0.1.0"
|
version = "0.1.1"
|
||||||
agent_id = coder_agent.example.id
|
agent_id = coder_agent.example.id
|
||||||
folder = "/home/coder/project"
|
folder = "/home/coder/project"
|
||||||
|
|
||||||
@ -40,6 +51,7 @@ module "cursor_cli" {
|
|||||||
force = true
|
force = true
|
||||||
model = "gpt-5"
|
model = "gpt-5"
|
||||||
ai_prompt = data.coder_parameter.ai_prompt.value
|
ai_prompt = data.coder_parameter.ai_prompt.value
|
||||||
|
api_key = "xxxx-xxxx-xxxx" # Required while using tasks, see note below
|
||||||
|
|
||||||
# Minimal MCP server (writes `folder/.cursor/mcp.json`):
|
# Minimal MCP server (writes `folder/.cursor/mcp.json`):
|
||||||
mcp = jsonencode({
|
mcp = jsonencode({
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user