《Cursor文檔》-命令

Origin 目前處於早期 beta 版。您可以創建倉庫、使用 Git 推送和拉取、從 GitHub 鏡像倉庫、瀏覽和搜索代碼、創建和合並 PR,以及與 Cursor 團隊共享。

歡迎通過 hi@cursor.com 提交任何反饋,幫助我們改進產品。

此處列出了除 PR 外的所有 origin 命令及其選項;PR 有單獨的頁面:PR 命令。要在終端中查看相同信息,請運行 origin --help 查看命令列表,或運行 origin <group> --help 查看某個羣組的命令。要安裝 CLI,請參閱安裝 CLI

Origin CLI (origin) 與 CLI 中介紹的 Cursor Agent CLI (agent) 相互獨立。

全局選項

以下選項適用於所有命令:

選項 描述
--auth-token Cursor 認證令牌,直接作爲 Bearer token 使用 (也可使用 CURSOR_AUTH_TOKEN)
--endpoint API 服務器端點 (默認值:https://origin.cursor.com)
--version 顯示已安裝的版本
--help 顯示當前命令的幫助信息

命令組

命令 描述 用法
auth 登錄、登出並配置 Git 身份驗證 origin auth login
repo 創建、列出、查看、克隆和刪除倉庫 origin repo create my-project
pr 創建、評審和合並 PR origin pr create
ruleset 查看 Origin 規則集 (合併時和推送時) 。別名:rs origin ruleset list
ssh-key 管理已註冊到您的 Origin 賬戶的 SSH 密鑰 origin ssh-key list
api <endpoint> 向位於 api.cursor.com/v1/origin 的 Origin REST API 發送已認證的請求 origin api /repos/{owner}/{repo}
completion 輸出 bash 或 zsh 的 Tab 補全腳本 origin completion >> ~/.zshrc
update origin 更新至您所在渠道的當前版本 origin update
config 管理配置,包括髮布渠道 origin config get-channel

指定代碼倉庫

大多數命令會根據當前 checkout 的 origin Git 遠程倉庫推斷代碼倉庫。可通過 -R, --repo 指定 org/name 格式的代碼倉庫:

origin pr list -R acme/checkout

身份驗證

管理會話和 Git 憑據助手。

子命令 描述 用法
login 通過瀏覽器登錄並配置 Git origin auth login
setup-git 爲 Origin Git 主機重新配置 Git 憑據助手 origin auth setup-git
status 顯示當前身份驗證方式和賬戶 origin auth status
logout 清除已保存的憑據 origin auth logout
命令 選項 描述
login --api-key <key> 使用 API 密鑰登錄,而不使用瀏覽器登錄流程。設置 CURSOR_API_KEY 後,origin auth login 無需此標誌即可使用它
login --local 在此代碼倉庫的 Git 配置中配置憑據助手,而非全局配置
setup-git --host <host> 要配置的 Origin Git 主機 (默認值:根據 --endpoint / CURSOR_ORIGIN_ENDPOINT 派生)
setup-git --global 應用於全局 Git 配置 (默認值:true)
setup-git --local 應用於此代碼倉庫的 Git 配置,而非全局配置

origin auth login 還會安裝 Git 憑據助手,因此無需額外設置即可對 Origin 遠程倉庫執行 git pushgit pull

代碼倉庫

子命令 描述 用法
create <repo> 創建代碼倉庫 origin repo create acme/checkout
create-mirrored <github-repo> 爲 GitHub 代碼倉庫創建 Cursor 鏡像 origin repo create-mirrored acme/checkout
list 列出你的賬戶有權訪問的代碼倉庫 origin repo list
view [repo] 顯示代碼倉庫信息 origin repo view acme/checkout
clone <repo> [directory] 使用已保存的登錄信息通過 HTTPS 克隆 origin repo clone acme/checkout
delete <repo> 刪除代碼倉庫 origin repo delete acme/checkout

傳入 org/name 以指定代碼倉庫。不帶斜槓的 origin repo create <name> 會在你的賬戶命名空間中創建代碼倉庫。

命令 選項 描述
create --default-branch <branch> 新建代碼倉庫的默認分支 (服務器默認值:main)
create-mirrored --namespace <namespace> 創建鏡像的命名空間 (默認值:你的賬戶命名空間)
create-mirrored --github-enterprise-id <uuid> GitHub Enterprise Server 應用 UUID。從 github.com 鏡像時可省略
list --namespace <namespace> 僅列出一個命名空間,而非所有有權訪問的命名空間
view --json <fields> 輸出包含所列字段的 JSON,例如 org,name,defaultBranch
delete -y, --yes 跳過確認提示。在非交互式 shell 中必填

規則集

查看爲代碼倉庫配置的合併和推送規則集:

子命令 描述 用法
list 列出爲代碼倉庫配置的規則集 origin ruleset list
view <ruleset-id> 按 ID 查看規則集,ID 由 origin ruleset list 輸出 origin ruleset view <id>

SSH 密鑰

管理您的 Origin 賬戶中的 SSH 公鑰:

子命令 描述 用法
add [key-file] 將 SSH 公鑰添加到您的賬戶。使用 -t 爲密鑰命名 origin ssh-key add ~/.ssh/id_ed25519.pub
list 列出您賬戶中的 SSH 公鑰 (使用 --json 以 JSON 格式輸出) origin ssh-key list
delete <id> 根據 ID 刪除密鑰,ID 可通過 origin ssh-key list 查看 origin ssh-key delete <id>

API 請求

對於沒有專用命令的操作,origin api 會向 api.cursor.com/v1/origin 上的 Origin REST API 發出已認證的請求。它支持與 gh api 類似的請求標誌:-X, --method-H, --header-F, --field-f, --raw-field--input-q, --jq{owner}{repo}{branch} 佔位符會根據 -R, --repoORIGIN_REPO 環境變量或 origin Git 遠程倉庫展開。有關端點、身份驗證和示例,請參閱 Origin API 文檔。

更新

更新到當前渠道的最新版本:

origin update

CLI 默認從 stable 渠道獲取更新。使用 origin config set-channel <latest|stable> 切換渠道,並使用 origin config get-channel 查看當前渠道。

Shell 補全

將補全腳本追加到 shell 配置中:

origin completion >> ~/.zshrc

--head--base 等接受分支值的標誌隨後會補全本地分支名稱。

環境變量

變量 描述
CURSOR_API_KEY origin auth login 的 API 密鑰。設置後,登錄會跳過瀏覽器流程
CURSOR_AUTH_TOKEN Bearer token,與 --auth-token 的值相同
CURSOR_ORIGIN_ENDPOINT 默認 API 服務器端點,與 --endpoint 的值相同
ORIGIN_REPO 未設置 origin 遠程倉庫時,origin api 使用的默認代碼倉庫,格式爲 org/name
NO_COLOR 關閉彩色輸出

獲取幫助信息

每個命令都支持 --help

origin --help
origin repo --help
origin repo create --help

後續步驟

羽毛球分组比赛记分
小程序二维码

欢迎使用《羽毛球分组比赛记分》微信小程序

小夜