Skip to content

fix: reformat cursor cli readme #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 18, 2025
Merged

fix: reformat cursor cli readme #336

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fdd74d7
fix: reformat cursor cli readme
35C4n0r Aug 18, 2025
685b998
Update registry/coder-labs/modules/cursor-cli/README.md
35C4n0r Aug 18, 2025
831d58b
fix: syntax from suggestion
35C4n0r Aug 18, 2025
96ba412
Merge branch 'main' into fix-cursor-cli-readme
DevelopmentCats Aug 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions registry/coder-labs/modules/cursor-cli/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
---
display_name: Cursor CLI
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
tags: [agent, cursor, ai, cli]
tags: [agent, cursor, ai, tasks]
---

# 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:

Expand All @@ -31,7 +42,7 @@ module "coder-login" {

module "cursor_cli" {
source = "registry.coder.com/coder-labs/cursor-cli/coder"
version = "0.1.0"
version = "0.1.1"
agent_id = coder_agent.example.id
folder = "/home/coder/project"

Expand All @@ -40,6 +51,7 @@ module "cursor_cli" {
force = true
model = "gpt-5"
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`):
mcp = jsonencode({
Expand Down