全局選項¶
全局選項可用於任何命令:
| 選項 | 描述 |
|---|---|
-v, --version |
輸出版本號 |
--api-key <key> |
用於身份驗證的 API 密鑰 (也可使用 CURSOR_API_KEY 環境變量) |
-H, --header <header> |
爲智能體請求添加自定義請求頭 (格式:Name: Value,可多次使用) |
-p, --print |
將響應輸出到控制檯 (適用於腳本或非交互式使用) 。可使用所有工具,包括寫入和 shell。 |
--output-format <format> |
輸出格式 (僅適用於 --print) :text、json 或 stream-json (默認值:text) |
--stream-partial-output |
將部分輸出以單獨的文本增量形式流式傳輸 (僅適用於 --print 和 stream-json 格式) |
--resume [chatId] |
恢復聊天會話 |
--continue |
繼續上一個會話 (--resume=-1 的別名) |
--model <model> |
要使用的模型 |
--mode <mode> |
設置智能體模式:plan 或 ask (未指定模式時,默認使用智能體模式) |
--plan |
以 Plan 模式啓動 (--mode=plan 的簡寫) |
--list-models |
列出所有可用模型 |
-f, --force |
除非明確拒絕,否則強制允許命令 |
--yolo |
--force 的別名 |
--sandbox <mode> |
設置沙盒模式:enabled 或 disabled |
--approve-mcps |
自動批准所有 MCP 服務器 |
--trust |
無需提示即信任工作區 (僅限無圖形界面模式) |
--workspace <path> |
要使用的工作區目錄 |
--plugin-dir <path> |
加載本地插件目錄 (可多次指定) |
-w, --worktree [name] |
在 ~/.cursor/worktrees/<reponame>/<name> 下新建的 Git worktree 中運行。未指定名稱時,將自動生成。 |
--worktree-base <branch> |
新 worktree 所基於的分支或引用 (默認值:當前 HEAD) |
--skip-worktree-setup |
跳過運行 .cursor/worktrees.json 中的 worktree 設置腳本 |
-h, --help |
顯示命令的幫助信息 |
命令¶
| 命令 | 描述 | 用法 | |
|---|---|---|---|
agent [prompt...] |
以智能體模式啓動 (默認) | agent agent "fix the tests" |
|
login |
登錄 Cursor | agent login |
|
logout |
退出登錄並清除已保存的身份驗證信息 | agent logout |
|
status |
whoami |
查看身份驗證狀態 | agent status |
about |
顯示版本、系統和賬戶信息 | agent about |
|
models |
列出此賬戶可用的模型 | agent models |
|
mcp |
管理 MCP 服務器 | agent mcp |
|
sandbox |
配置沙盒模式,或在沙盒中運行單個命令 (隱藏) | agent sandbox enable |
|
worker |
啓動私有云 worker,在你的環境中運行智能體 | agent worker start |
|
acp |
啓動 ACP 服務器模式 (高級隱藏命令) | agent acp |
|
update |
將 Cursor Agent 更新至最新版本 | agent update |
|
ls |
恢復聊天會話 | agent ls |
|
resume |
恢復最近的聊天會話 | agent resume |
|
create-chat |
創建新的空聊天並返回其 ID | agent create-chat |
|
generate-rule |
rule |
通過交互式提示生成新的 Cursor 規則 | agent generate-rule |
install-shell-integration |
將 shell 集成安裝到 ~/.zshrc |
agent install-shell-integration |
|
uninstall-shell-integration |
從 ~/.zshrc 中移除 shell 集成 |
agent uninstall-shell-integration |
|
help [command] |
顯示命令的幫助信息 | agent help [command] |
agent acp 適用於自定義 ACP 客戶端和高級集成,默認命令幫助輸出中不會顯示此命令。
未指定命令時,Cursor Agent 默認以交互式智能體模式啓動。
MCP¶
管理爲 Cursor Agent 配置的 MCP 服務器。
| 子命令 | 描述 | 用法 |
|---|---|---|
login <identifier> |
向 .cursor/mcp.json 或 ~/.cursor/mcp.json 中配置的 MCP 服務器進行認證 |
agent mcp login <identifier> |
list |
列出已配置的 MCP 服務器及其狀態 | agent mcp list |
list-tools <identifier> |
列出指定 MCP 的可用工具及其參數名稱 | agent mcp list-tools <identifier> |
enable <identifier> |
將 MCP 服務器添加到本地已批准列表 | agent mcp enable <identifier> |
disable <identifier> |
禁用 MCP 服務器,使其不再加載或請求批准 | agent mcp disable <identifier> |
所有 MCP 命令均支持 -h, --help,可查看針對具體命令的幫助信息。
沙盒¶
配置沙盒模式,或在沙盒中運行單個命令。
| 子命令 | 描述 | 用法 |
|---|---|---|
enable |
啓用命令執行沙盒模式 | agent sandbox enable |
disable |
禁用沙盒模式並使用允許列表模式 | agent sandbox disable |
reset |
將沙盒配置重置爲默認值 | agent sandbox reset |
run <cmd> [args...] |
在具有工作區讀寫權限的沙盒中運行命令 | agent sandbox run ls |
help [command] |
顯示命令的幫助信息 | agent sandbox help |
| 命令 | 選項 | 描述 |
|---|---|---|
sandbox run |
--allow-paths <paths> |
額外讀寫路徑的以逗號分隔列表 |
sandbox run |
--readonly-paths <paths> |
額外只讀路徑的以逗號分隔列表 |
sandbox run |
--blocked-patterns <patterns> |
要阻止的 gitignore 風格模式的以逗號分隔列表 |
sandbox run |
--sandbox |
使用工作區讀寫沙盒策略運行 (默認值:true) |
sandbox run |
--network |
啓用沙盒中的網絡訪問 (默認值:false) |
sandbox run |
--sb-debug |
將沙盒調試日誌寫入臨時文件夾並輸出路徑 |
所有沙盒命令均支持使用 -h, --help 查看針對具體命令的幫助信息。
Worker¶
啓動一個連接到 Cursor 並在您的環境中運行智能體的私有云 worker。
| 子命令 | 描述 | 用法 |
|---|---|---|
start |
啓動 worker 並連接到 Cursor | agent worker start |
debug |
對認證、隱私和路由執行私有 worker 啓動前診斷 | agent worker debug |
help [command] |
顯示命令的幫助信息 | agent worker help |
| 命令 | 選項 | 描述 |
|---|---|---|
worker |
--auth-token-file <path> |
包含 worker 認證令牌的文件路徑 |
worker |
--worker-dir <path> |
向智能體開放的工作區根目錄。可重複指定。第一個值爲分配身份標識。 |
worker |
--management-addr <address> |
/healthz、/readyz 和 /metrics 的監聽地址 |
worker |
--label <key=value> |
添加 worker 標籤。可多次使用。不能與 --labels-file 同時使用。 |
worker |
--labels-file <path> |
JSON 或 TOML 標籤文件的路徑。也可使用 CURSOR_WORKER_LABELS_FILE。 |
worker |
--idle-release-timeout <seconds> |
worker 空閒後可保持連接的秒數。默認值 0 會禁用基於空閒狀態的釋放。 |
worker |
--pool |
註冊以接受用量池分配。每次只能有一個雲端代理佔用該 worker。 |
worker |
--single-use |
--pool 的舊版別名 |
worker |
--pool-name <name> |
用量池 worker 的用量池標籤。需要 --pool 或 --single-use。默認值爲 default。 |
worker |
--name <name> |
自定義顯示名稱。默認值爲機器主機名。 |
worker |
--data-dir <path> |
用於存儲日誌、產物和錄製數據的基礎目錄 |
worker |
--debug |
啓動橋接模式前輸出 worker 調試診斷信息 |
worker start |
--verbose |
啓用詳細的啓動日誌 |
worker debug |
--json |
以 JSON 格式輸出調試報告 |
命令專屬選項¶
| 命令 | 選項 | 描述 |
|---|---|---|
status, whoami |
--format <format> |
輸出格式:text 或 json (默認值:text) |
about |
--format <format> |
輸出格式:text 或 json (默認值:text) |
參數¶
以聊天模式啓動時 (默認行爲) ,可以提供初始提示詞:
參數:
prompt— 智能體的初始提示詞
獲取幫助信息¶
所有命令均支持全局 -h, --help 選項,用於顯示針對具體命令的幫助信息。