本文檔介紹 Cursor Review 命令行界面 (gt) 中所有可用的命令和標誌。
該命令行界面完全支持多個 Git 工作樹。從 gt 版本 1.8.4 起，gt 在大多數情況下不會修改已在其他 工作樹 中檢出的分支。
每個命令都會說明其功能和運行方式。帶有標誌的命令下方提供快速參考行和可摺疊的標誌表。要查看最新詳情，請運行 gt COMMAND --help (將 COMMAND 替換爲命令名稱) 。
全局標誌
全局標誌可與任何命令一起使用：
| 選項 |
描述 |
--help |
顯示命令的幫助信息。 |
--allCommands |
不會顯示在全局幫助信息中。運行 gt --help --all 可顯示完整的命令幫助列表。 |
--cwd <path> |
執行操作時使用的工作目錄。 |
--debug |
將調試輸出寫入終端。 |
--interactive |
啓用提示詞、分頁器和編輯器等交互功能。默認啓用。使用 --no-interactive 禁用。 |
--verify |
啓用 Git 鉤子。默認啓用。使用 --no-verify 禁用。 |
--quiet |
儘量減少終端輸出。隱含 --no-interactive。 |
不帶標誌的命令
不接受標誌的命令。參數用方括號括起。
| 命令 |
描述 |
用法 |
add [args..] |
透傳給 git add。 |
gt add [args..] |
bottom |
切換到當前分支棧中最接近主幹的分支。 |
gt bottom |
changelog |
顯示 命令行界面 更新日誌。 |
gt changelog |
cherry-pick [args..] |
透傳給 git cherry-pick。 |
gt cherry-pick [args..] |
children |
顯示當前分支的子分支。 |
gt children |
completion |
設置 bash 或 zsh 的 Tab 補全。 |
gt completion |
config |
配置 命令行界面。 |
gt config |
dash |
打開 Cursor Review 儀表盤。 |
gt dash |
demo [demoName] |
運行交互式演示，瞭解 命令行界面 工作流。 |
gt demo [demoName] |
docs |
顯示 命令行界面 文檔。 |
gt docs |
fish |
設置 fish 的 Tab 補全。 |
gt fish |
freeze [branch] |
凍結一個分支及其下層分支，禁止本地修改。 |
gt freeze [branch] |
guide [title] |
閱讀有關使用 gt 的詳細指南。 |
gt guide [title] |
parent |
顯示當前分支的父分支。 |
gt parent |
pop |
刪除當前分支，但保留工作樹中文件的狀態。 |
gt pop |
rebase [args..] |
透傳給 git rebase。 |
gt rebase [args..] |
reset [args..] |
透傳給 git reset。 |
gt reset [args..] |
restore [args..] |
透傳給 git restore。 |
gt restore [args..] |
top |
切換到當前分支棧的頂端分支。 |
gt top |
unfreeze [branch] |
解凍一個分支及其上層分支，重新允許本地修改。 |
gt unfreeze [branch] |
unlink [branch] |
解除該分支當前關聯的 PR。 |
gt unlink [branch] |
upgrade |
將 命令行界面 升級到最新穩定版本。 |
gt upgrade |
帶標誌的命令
接受標誌的命令概覽。在下方列表中展開命令以查看標誌詳情。
| 命令 |
描述 |
用法 |
abort |
中止因變基衝突而暫停的當前 Graphite 命令。 |
gt abort |
absorb |
將暫存的更改修訂到當前分支棧中的相關提交，然後重新整理上層分支。 |
gt absorb |
aliases |
編輯命令別名。 |
gt aliases |
auth |
添加認證令牌，以便 命令行界面 能夠在 GitHub 上創建和更新 PR。 |
gt auth |
checkout |
切換到某個分支；如果省略，則打開交互式選擇器。 |
gt checkout [branch] |
continue |
繼續最近因變基衝突而暫停的 Graphite 命令。 |
gt continue |
create |
創建一個疊加在當前分支之上的分支，並提交暫存的更改。 |
gt create [name] |
delete |
刪除分支和 命令行界面 元數據；子分支將重新整理到父分支上。 |
gt delete [name] |
down |
切換到當前分支的父分支。 |
gt down [steps] |
feedback |
向 命令行界面 維護者發送反饋。 |
gt feedback [message] |
fold |
將分支合併到其父分支，更新後代分支並重新整理。 |
gt fold |
get |
從遠程同步主幹到指定分支或 PR 的各分支。 |
gt get [branch] |
info |
顯示分支信息。 |
gt info [branch] |
init |
選擇主幹分支後，在此倉庫中初始化 命令行界面。 |
gt init |
log |
顯示分支棧 (gt log、gt log short、gt log long) 。 |
gt log [command] |
merge |
合併從主幹到當前分支的所有分支的 PR。 |
gt merge |
modify |
修訂當前提交或創建新提交；重新整理後代分支。 |
gt modify |
move |
將當前分支變基到目標分支，並重新整理後代分支。 |
gt move |
pr |
打開分支或 PR 編號對應的 PR 頁面。 |
gt pr [branch] |
rename |
重命名分支並更新元數據 (會斷開與 PR 分支的關聯) 。 |
gt rename [name] |
reorder |
重新排序主幹與當前分支之間的分支；重新整理後代分支。 |
gt reorder |
restack |
將每個分支變基到其父分支，使歷史記錄包含父分支的提交。 |
gt restack |
revert |
創建一個還原主幹提交的分支 (實驗性) 。 |
gt revert [sha] |
split |
將當前分支拆分爲多個分支。 |
gt split |
squash |
壓縮當前分支上的所有提交，並重新整理上層分支。 |
gt squash |
submit |
將當前分支棧推送到 GitHub，並創建或更新 PR。 |
gt submit |
sync |
與遠程同步，清理已合併的 PR 分支，並重新整理。 |
gt sync |
track |
通過選擇父分支開始跟蹤分支。 |
gt track [branch] |
trunk |
顯示當前分支的主幹。 |
gt trunk |
undo |
撤銷此工作樹中最近的 命令行界面 修改操作。 |
gt undo |
untrack |
停止跟蹤分支 (及其子分支) 。 |
gt untrack [branch] |
up |
切換到當前分支的子分支。 |
gt up [steps] |
參數標誌參考
gt abort
| 標誌 |
描述 |
-f, --force |
不要求確認，立即中止。 |
gt absorb
| 標誌 |
描述 |
-a, --all |
吸收前暫存尚未暫存的更改 (不包括未跟蹤的文件) 。 |
-d, --dry-run |
輸出目標提交，但不應用更改。 |
-f, --force |
無需確認，直接應用代碼塊。 |
-p, --patch |
吸收前選擇要暫存的代碼塊。 |
gt 別名
| 標誌 |
描述 |
--legacy |
將舊版別名添加到配置中。 |
--reset |
重置別名配置。 |
gt 認證
| 標誌 |
描述 |
-t, --token |
Cursor Review 命令行界面設置中的認證令牌。 |
gt checkout [分支]
| 標誌 |
描述 |
-a, --all |
顯示所有已配置主幹上的分支。 |
-u, --show-untracked |
包括未跟蹤的分支。 |
-s, --stack |
將選擇範圍限定爲當前分支棧。 |
-t, --trunk |
切換到當前主幹。 |
gt continue
| 標誌 |
描述 |
-a, --all |
繼續前暫存所有更改。 |
gt create [name]
| 標誌 |
描述 |
--ai |
使用 AI 生成分支名稱和提交信息。 |
-a, --all |
暫存所有更改，包括未跟蹤的文件。 |
-i, --insert |
插入到當前分支與其子分支之間。 |
-m, --message |
提交信息。 |
--no-ai |
禁用 AI 生成 (覆蓋 --ai) 。 |
-p, --patch |
選擇要暫存的代碼塊。 |
-u, --update |
暫存已跟蹤文件的更新。 |
-v, --verbose |
在提交信息模板中顯示提交 diff。 |
-o, --onto |
基於另一個分支創建。 |
gt delete [名稱]
| 標誌 |
描述 |
-c, --close |
在 GitHub 上關閉關聯的 PR。 |
--downstack |
同時刪除上游分支。 |
-f, --force |
即使未合併或未關閉也強制刪除。 |
--upstack |
同時刪除子分支。 |
向下移動 [步數]
| 標誌 |
描述 |
-n, --steps |
向下遍歷的層數。 |
gt 反饋 [消息]
| 標誌 |
描述 |
-d, --with-debug-context |
包含過去 24 小時的日誌。 |
gt fold
| 標誌 |
描述 |
-c, --close |
關閉 GitHub 上關聯的 PR。 |
-k, --keep |
保留當前分支名稱。 |
--stack |
將整個分支棧合併爲一個分支。 |
gt 獲取 [分支]
| 標誌 |
描述 |
--checkout |
同步後檢出目標 (默認值；使用 --no-checkout 跳過) 。 |
--delete-all |
刪除已合併或已關閉的分支，無需確認。 |
-d, --downstack |
當分支已存在於本地時，不同步上層分支。 |
-f, --force |
用遠程分支覆蓋已獲取的分支。 |
--restack |
無衝突地重新整理 (默認值；使用 --no-restack 跳過) 。 |
-U, --unfrozen |
將新分支檢出爲未凍結狀態。 |
-u, --remote-upstack |
包含遠程的上層 PR。 |
gt info [分支]
| 標誌 |
描述 |
-b, --body |
顯示 PR 正文。 |
-d, --diff |
顯示與父分支的 diff (覆蓋 --patch) 。 |
-p, --patch |
按提交顯示更改。 |
-s, --stat |
Diffstat (若均未設置，則隱含 --diff) 。 |
gt init
| 標誌 |
描述 |
--reset |
停止跟蹤所有分支。 |
--trunk |
主幹分支名稱 (省略時會提示輸入) 。 |
gt log [命令]
| 標誌 |
描述 |
-a, --all |
所有主幹中的分支。 |
--classic |
舊版簡潔日誌樣式。 |
-r, --reverse |
反向打印。 |
-u, --show-untracked |
包含未跟蹤分支。 |
-s, --stack |
僅顯示當前分支棧。 |
-n, --steps |
限制上層/下層深度 (自動啓用 --stack) 。 |
gt 合併
| 標誌 |
描述 |
-c, --confirm |
合併前進行確認。 |
--dry-run |
列出將會合並但不會實際合併的 PR。 |
gt modify
| 標誌 |
描述 |
-a, --all |
暫存所有更改。 |
-c, --commit |
創建新提交，而不是修訂現有提交。 |
-e, --edit |
編輯提交消息。 |
--interactive-rebase |
啓動交互式變基。 |
--into |
修改下層分支。 |
-m, --message |
提交消息。 |
-p, --patch |
選擇代碼塊。 |
--reset-author |
修訂時將作者設爲當前用戶。 |
-u, --update |
暫存已跟蹤文件的更新。 |
-v, --verbose |
在模板中顯示提交 diff。 |
gt move
| 標誌 |
描述 |
-a, --all |
在交互式選擇中顯示所有主幹。 |
--only |
僅移動此分支。 |
-o, --onto |
目標分支。 |
-s, --source |
要移動的分支 (默認值：當前分支) 。 |
gt pr [branch]
gt rename [名稱]
| 標誌 |
描述 |
-f, --force |
重命名關聯未關閉 GitHub PR 的分支。 |
gt reorder
| 標誌 |
描述 |
--stack |
包含直至 gt top 的完整上游分支棧。 |
gt 重新整理
| 標誌 |
描述 |
--branch |
指定運行所用的 Branch (默認值：當前) 。 |
-d, --downstack |
僅此 Branch 及其祖先分支。 |
-o, --only |
僅此 Branch。 |
-u, --upstack |
僅此 Branch 及其後代分支。 |
gt revert [sha]
gt split
| 標誌 |
描述 |
-c, --commit, --by-commit |
按 commit 拆分。 |
-f, --file, --by-file |
按路徑規範拆分 (可重複指定) 。 |
-h, --hunk, --by-hunk |
按 hunk 拆分。 |
gt squash
| 標誌 |
描述 |
--edit |
編輯提交消息。 |
-m, --message |
新消息。 |
-n, --no-edit |
保留消息 (覆蓋 --edit 的設置) 。 |
gt submit
| 標誌 |
描述 |
--ai |
使用 AI 爲新 PR 生成標題和描述。 |
--always |
即使沒有變更也推送。 |
--branch |
從此分支運行。 |
--cli |
在 CLI 中編輯 PR 元數據。 |
--comment |
添加 PR 評論。 |
-c, --confirm |
推送前確認。 |
-d, --draft |
將新 PR 創建爲草稿。 |
--dry-run |
僅生成報告。 |
-e, --edit |
編輯所有 PR 的元數據。 |
--edit-description |
提示輸入描述。 |
--edit-title |
提示輸入標題。 |
-f, --force |
強制推送。 |
--ignore-out-of-sync-trunk |
即使主幹有偏差也提交。 |
-m, --merge-when-ready |
標記爲準備就緒後合併。 |
--no-ai |
跳過 AI。 |
-n, --no-edit |
跳過行內編輯。 |
--no-edit-description |
跳過描述輸入提示。 |
--no-edit-title |
跳過標題輸入提示。 |
-p, --publish |
發佈已提交的 PR。 |
--rerequest-review |
重新請求評審。 |
--restack |
提交前重新整理。 |
-r, --reviewers |
設置審閱人。 |
-s, --stack |
提交下游分支 (使用 --no-stack 縮小範圍) 。 |
--target-trunk |
新 PR 的遠程主幹。 |
-t, --team-reviewers |
團隊審閱人的 slug。 |
-u, --update-only |
僅更新現有 PR。 |
-v, --view |
在瀏覽器中打開 PR。 |
-w, --web |
在網頁端編輯元數據。 |
gt sync
| 標誌 |
描述 |
-a, --all |
在所有主幹之間同步。 |
-d, --delete-all |
不經提示，刪除已合併或已關閉的分支。 |
-f, --force |
跳過確認提示。 |
--restack |
儘可能重新整理 (默認值；使用 --no-restack 可跳過) 。 |
gt track [分支]
| 標誌 |
描述 |
-f, --force |
將父分支設爲最新的已跟蹤祖先分支。 |
-p, --parent |
顯式指定父分支 (已跟蹤分支) 。 |
gt 主幹
| 標誌 |
描述 |
--add |
添加另一個主幹。 |
-a, --all |
顯示所有已配置的主幹。 |
gt undo
| 標誌 |
描述 |
-f, --force |
無需確認即可撤銷操作。 |
gt 取消跟蹤 [分支]
| 標誌 |
描述 |
-f, --force |
有子分支時，無需確認即可取消跟蹤。 |
gt up [steps]
| 標誌 |
描述 |
-n, --steps |
向上遍歷分支棧的層數。 |
--to |
前往目標分支。 |
