跳轉到主要內容

Documentation Index

Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

CLI 命令

您可以使用這些命令來啟動工作階段、管道內容、繼續對話和管理更新:
命令描述範例
claude啟動互動式工作階段claude
claude "query"使用初始提示啟動互動式工作階段claude "explain this project"
claude -p "query"透過 SDK 查詢,然後退出claude -p "explain this function"
cat file | claude -p "query"處理管道內容cat logs.txt | claude -p "explain"
claude -c在目前目錄中繼續最近的對話claude -c
claude -c -p "query"透過 SDK 繼續claude -c -p "Check for type errors"
claude -r "<session>" "query"按 ID 或名稱繼續工作階段claude -r "auth-refactor" "Finish this PR"
claude update更新至最新版本claude update
claude install [version]安裝或重新安裝原生二進位檔。接受版本如 2.1.118stablelatest。請參閱 安裝特定版本claude install stable
claude auth login登入您的 Anthropic 帳戶。使用 --email 預先填入您的電子郵件地址,使用 --sso 強制進行 SSO 驗證,使用 --console 以 Anthropic Console 登入以進行 API 使用計費,而不是 Claude 訂閱claude auth login --console
claude auth logout從您的 Anthropic 帳戶登出claude auth logout
claude auth status以 JSON 格式顯示驗證狀態。使用 --text 以人類可讀的格式輸出。如果已登入則以代碼 0 退出,如果未登入則以代碼 1 退出claude auth status
claude agents開啟 agent view 以監控和分派平行背景工作階段。使用 --cwd <path> 僅顯示在該目錄下啟動的工作階段,或使用 --json 將即時工作階段列印為 JSON 陣列以供指令碼使用。傳遞 --permission-mode--model--effort--agent 以設定 分派工作階段的預設值。接受 --settings--add-dir--plugin-dir--mcp-config,如同頂層 claude 命令。開啟 agent view 需要互動式終端claude agents --json
claude attach <id>在此終端中附加到 background sessionclaude attach 7c5dcf5d
claude auto-mode defaults以 JSON 格式列印內建的 auto mode 分類器規則。使用 claude auto-mode config 查看您的有效設定及套用的設定claude auto-mode defaults > rules.json
claude daemon status列印背景工作階段 supervisor 的狀態、版本、socket 目錄和工作者計數以進行診斷。如果 supervisor 未執行則以代碼 1 退出claude daemon status
claude logs <id>background session 列印最近的輸出claude logs 7c5dcf5d
claude mcp設定 Model Context Protocol (MCP) 伺服器請參閱 Claude Code MCP 文件
claude plugin管理 Claude Code plugins。別名:claude plugins。請參閱 plugin 參考 以了解子命令claude plugin install code-review@claude-plugins-official
claude project purge [path]刪除專案的所有本機 Claude Code 狀態:文字記錄、工作清單、偵錯日誌、檔案編輯歷史記錄、提示歷史記錄行和專案在 ~/.claude.json 中的項目。省略 [path] 以從互動式清單中選擇。旗標:--dry-run 以預覽,-y/--yes 以跳過確認,-i/--interactive 以確認每個項目,--all 用於每個專案。請參閱 清除本機資料claude project purge ~/work/repo --dry-run
claude remote-control啟動 Remote Control 伺服器以從 Claude.ai 或 Claude 應用程式控制 Claude Code。在伺服器模式下執行(無本機互動式工作階段)。請參閱 伺服器模式旗標claude remote-control --name "My Project"
claude respawn <id>重新啟動 background session(執行中或已停止),保持其對話完整。使用 --all 重新啟動每個執行中的工作階段,例如以取得更新的 Claude Code 二進位檔claude respawn 7c5dcf5d
claude rm <id>從清單中移除 background session。對話文字記錄保留在您的本機電腦上,可透過 claude --resume 取得claude rm 7c5dcf5d
claude setup-token為 CI 和指令碼產生長期 OAuth 權杖。將權杖列印到終端而不儲存它。需要 Claude 訂閱。請參閱 產生長期權杖claude setup-token
claude stop <id>停止 background session。也接受 claude killclaude stop 7c5dcf5d
claude ultrareview [target]非互動式執行 ultrareview。將發現列印到標準輸出,成功時以代碼 0 退出,失敗時以代碼 1 退出。使用 --json 取得原始承載,使用 --timeout <minutes> 覆蓋 30 分鐘的預設值claude ultrareview 1234 --json
如果您輸入錯誤的子命令,Claude Code 會建議最接近的匹配項並退出而不啟動工作階段。例如,claude udpate 會列印 Did you mean claude update?

CLI 旗標

使用這些命令列旗標自訂 Claude Code 的行為。claude --help 不會列出每個旗標,因此旗標在 --help 中的缺失並不表示它無法使用。
旗標描述範例
--add-dir新增額外的工作目錄供 Claude 讀取和編輯檔案。授予檔案存取權;大多數 .claude/ 設定 未從這些目錄探索。驗證每個路徑是否存在為目錄。若要在工作階段之間持久化這些目錄,請在設定中設定 permissions.additionalDirectoriesclaude --add-dir ../apps ../lib
--agent為目前工作階段指定代理程式(覆蓋 agent 設定)claude --agent my-custom-agent
--agents透過 JSON 動態定義自訂 subagents。使用與 subagent frontmatter 相同的欄位名稱,加上代理程式指示的 prompt 欄位claude --agents '{"reviewer":{"description":"Reviews code","prompt":"You are a code reviewer"}}'
--allow-dangerously-skip-permissions新增 bypassPermissionsShift+Tab 模式循環而不立即啟動它。允許您以不同的模式(如 plan)開始,稍後切換到 bypassPermissions。請參閱 permission modesclaude --permission-mode plan --allow-dangerously-skip-permissions
--allowedTools無需提示權限即可執行的工具。請參閱 permission rule syntax 以了解模式匹配。若要限制可用的工具,請改用 --tools"Bash(git log *)" "Bash(git diff *)" "Read"
--append-system-prompt將自訂文字附加到預設系統提示的末尾claude --append-system-prompt "Always use TypeScript"
--append-system-prompt-file從檔案載入額外的系統提示文字並附加到預設提示claude --append-system-prompt-file ./extra-rules.txt
--bare最小模式:跳過 hooks、skills、plugins、MCP 伺服器、自動記憶體和 CLAUDE.md 的自動探索,以便指令碼呼叫啟動更快。Claude 可以存取 Bash、檔案讀取和檔案編輯工具。設定 CLAUDE_CODE_SIMPLE。請參閱 bare modeclaude --bare -p "query"
--betas要包含在 API 請求中的 Beta 標頭(僅限 API 金鑰使用者)claude --betas interleaved-thinking
--bgbackground agent 身份啟動工作階段並立即返回。列印工作階段 ID 和管理命令。與 --exec 結合以執行 shell 命令作為背景工作而不是 Claude 工作階段,或與 --agent 結合以執行特定 subagentclaude --bg "investigate the flaky test"
--channels(研究預覽)MCP 伺服器,其 channel 通知 Claude 應在此工作階段中監聽。以空格分隔的 plugin:<name>@<marketplace> 項目清單。需要 Claude.ai 驗證claude --channels plugin:my-notifier@my-marketplace
--chrome啟用 Chrome 瀏覽器整合 以進行網頁自動化和測試claude --chrome
--continue, -c載入目前目錄中最近的對話。包括使用 /add-dir 新增此目錄的工作階段claude --continue
--dangerously-load-development-channels啟用不在核准允許清單上的 channels,用於本機開發。接受 plugin:<name>@<marketplace>server:<name> 項目。提示確認claude --dangerously-load-development-channels server:webhook
--dangerously-skip-permissions略過權限提示。等同於 --permission-mode bypassPermissions。請參閱 permission modes 以了解此操作會和不會略過的內容claude --dangerously-skip-permissions
--debug啟用偵錯模式,可選類別篩選(例如,"api,hooks""!statsig,!file"claude --debug "api,mcp"
--debug-file <path>將偵錯日誌寫入特定檔案路徑。隱含啟用偵錯模式。優先於 CLAUDE_CODE_DEBUG_LOGS_DIRclaude --debug-file /tmp/claude-debug.log
--disable-slash-commands為此工作階段停用所有 skills 和命令claude --disable-slash-commands
--disallowedTools拒絕規則。裸工具名稱會從模型的內容中移除該工具。範圍規則(例如 Bash(rm *) )會保留工具可用,但只拒絕符合的呼叫"Bash(git log *)" "Bash(git diff *)" "Edit"
--effort為目前工作階段設定 effort level。選項:lowmediumhighxhighmax;可用的層級取決於模型。覆蓋此工作階段的 effortLevel 設定,且不會持久化claude --effort high
--enable-auto-mode在 v2.1.111 中移除。Auto mode 現在預設在 Shift+Tab 循環中;使用 --permission-mode auto 以它開始claude --permission-mode auto
--exclude-dynamic-system-prompt-sections將每台機器的系統提示部分(工作目錄、環境資訊、記憶體路徑、git 狀態旗標)移至第一個使用者訊息。改善在執行相同工作的不同使用者和機器之間的提示快取重複使用。僅適用於預設系統提示;設定 --system-prompt--system-prompt-file 時忽略。與 -p 搭配使用以進行指令碼化、多使用者工作負載claude -p --exclude-dynamic-system-prompt-sections "query"
--exec執行 shell 命令作為 PTY 支援的背景工作而不是啟動 Claude 工作階段。與 --bg 搭配使用以從 shell 啟動claude --bg --exec 'pytest -x'
--fallback-model當預設模型過載或無法使用時啟用自動回退到指定的模型,例如已淘汰的模型。在列印模式(-p)和 background sessions 中生效,這些工作階段以非互動方式執行;在互動式工作階段中忽略claude -p --fallback-model sonnet "query"
--fork-session繼續時,建立新的工作階段 ID 而不是重複使用原始 ID(與 --resume--continue 搭配使用)claude --resume abc123 --fork-session
--from-pr繼續連結到特定提取請求的工作階段。接受 PR 編號、GitHub 或 GitHub Enterprise PR URL、GitLab 合併請求 URL 或 Bitbucket 提取請求 URL。當 Claude 建立提取請求時,工作階段會自動連結claude --from-pr 123
--ide如果恰好有一個有效的 IDE 可用,在啟動時自動連線到 IDEclaude --ide
--init在工作階段前執行 Setup hooks,使用 init 匹配器(僅列印模式)claude -p --init "query"
--init-only執行 SetupSessionStart hooks,然後退出而不啟動對話claude --init-only
--include-hook-events在輸出串流中包含所有 hook 生命週期事件。需要 --output-format stream-jsonclaude -p --output-format stream-json --verbose --include-hook-events "query"
--include-partial-messages在輸出中包含部分串流事件。需要 --print--output-format stream-jsonclaude -p --output-format stream-json --verbose --include-partial-messages "query"
--input-format為列印模式指定輸入格式(選項:textstream-jsonclaude -p --output-format json --input-format stream-json
--json-schema在代理程式完成其工作流程後取得符合 JSON Schema 的驗證 JSON 輸出(僅列印模式,請參閱 structured outputsclaude -p --json-schema '{"type":"object","properties":{...}}' "query"
--maintenance在工作階段前執行 Setup hooks,使用 maintenance 匹配器(僅列印模式)claude -p --maintenance "query"
--max-budget-usd在停止前在 API 呼叫上花費的最大美元金額(僅列印模式)claude -p --max-budget-usd 5.00 "query"
--max-turns限制代理程式轉數(僅列印模式)。達到限制時以錯誤退出。預設無限制claude -p --max-turns 3 "query"
--mcp-config從 JSON 檔案或字串載入 MCP 伺服器(以空格分隔)claude --mcp-config ./mcp.json
--model使用最新模型的別名(sonnetopus)或模型的完整名稱為目前工作階段設定模型。覆蓋 model 設定和 ANTHROPIC_MODELclaude --model claude-sonnet-4-6
--name, -n為工作階段設定顯示名稱,顯示在 /resume 和終端標題中。您可以使用 claude --resume <name> 繼續已命名的工作階段。

/rename 在工作階段中途變更名稱,也會在提示列中顯示
claude -n "my-feature-work"
--no-chrome為此工作階段停用 Chrome 瀏覽器整合claude --no-chrome
--no-session-persistence停用工作階段持久性,使工作階段不會儲存到磁碟且無法繼續。僅列印模式。CLAUDE_CODE_SKIP_PROMPT_HISTORY 環境變數在任何模式中執行相同操作claude -p --no-session-persistence "query"
--output-format為列印模式指定輸出格式(選項:textjsonstream-jsonclaude -p "query" --output-format json
--permission-mode以指定的 permission mode 開始。接受 defaultacceptEditsplanautodontAskbypassPermissions。覆蓋設定檔案中的 defaultModeclaude --permission-mode plan
--permission-prompt-tool指定 MCP 工具以在非互動模式下處理權限提示claude -p --permission-prompt-tool mcp_auth_tool "query"
--plugin-dir為此工作階段僅從目錄或 .zip 封存載入 plugin。每個旗標採用一個路徑。重複旗標以使用多個 plugins:--plugin-dir A --plugin-dir B.zipclaude --plugin-dir ./my-plugin
--plugin-url為此工作階段僅從 URL 擷取 plugin .zip 封存。重複旗標以使用多個 plugins,或在單一引用值中傳遞以空格分隔的 URLclaude --plugin-url https://example.com/plugin.zip
--print, -p列印回應而不進入互動模式(請參閱 Agent SDK 文件 以了解程式化使用詳細資訊)claude -p "query"
--prompt-suggestions在每個轉數後發出 prompt_suggestion 訊息,其中包含預測的下一個使用者提示。需要 --print--output-format stream-json--verbose。請參閱 Prompt suggestionsclaude -p --prompt-suggestions --output-format stream-json --verbose "query"
--remote在 claude.ai 上建立新的 web session,並提供工作描述claude --remote "Fix the login bug"
--remote-control, --rc啟動互動式工作階段,並啟用 Remote Control,以便您也可以從 claude.ai 或 Claude 應用程式控制它。可選擇傳遞工作階段的名稱claude --remote-control "My Project"
--remote-control-session-name-prefix <prefix>Remote Control 工作階段名稱的前綴,當未設定明確名稱時自動產生。預設為您的機器主機名稱,產生如 myhost-graceful-unicorn 的名稱。設定 CLAUDE_REMOTE_CONTROL_SESSION_NAME_PREFIX 以獲得相同效果claude remote-control --remote-control-session-name-prefix dev-box
--replay-user-messages從 stdin 重新發出使用者訊息回到 stdout 以進行確認。需要 --input-format stream-json--output-format stream-jsonclaude -p --input-format stream-json --output-format stream-json --verbose --replay-user-messages
--resume, -r按 ID 或名稱繼續特定工作階段,或顯示互動式選擇器以選擇工作階段。包括使用 /add-dir 新增此目錄的工作階段。自 v2.1.144 起,background sessions 在選擇器中出現,標記為 bgclaude --resume auth-refactor
--session-id為對話使用特定的工作階段 ID(必須是有效的 UUID)claude --session-id "550e8400-e29b-41d4-a716-446655440000"
--setting-sources要載入的設定來源的逗號分隔清單(userprojectlocalclaude --setting-sources user,project
--settings設定 JSON 檔案的路徑或內嵌 JSON 字串。您在此設定的值會覆蓋此工作階段中 settings.json 檔案中的相同金鑰。您省略的金鑰保留其檔案型值。請參閱 settings precedenceclaude --settings ./settings.json
--strict-mcp-config僅使用 --mcp-config 中的 MCP 伺服器,忽略所有其他 MCP 設定claude --strict-mcp-config --mcp-config ./mcp.json
--system-prompt用自訂文字取代整個系統提示claude --system-prompt "You are a Python expert"
--system-prompt-file從檔案載入系統提示,取代預設提示claude --system-prompt-file ./custom-prompt.txt
--teleport在本機終端中繼續 web sessionclaude --teleport
--teammate-mode設定 agent team 隊友的顯示方式:auto(預設)、in-processtmux。覆蓋此工作階段的 teammateMode 設定。請參閱 選擇顯示模式claude --teammate-mode in-process
--tmux為 worktree 建立 tmux 工作階段。需要 --worktree。在可用時使用 iTerm2 原生窗格;傳遞 --tmux=classic 以使用傳統 tmuxclaude -w feature-auth --tmux
--tools限制 Claude 可以使用的內建工具。使用 "" 停用全部,"default" 為全部,或工具名稱如 "Bash,Edit,Read"claude --tools "Bash,Edit,Read"
--verbose啟用詳細記錄,顯示完整的逐轉輸出。覆蓋此工作階段的 viewMode 設定claude --verbose
--version, -v輸出版本號claude -v
--worktree, -w在隔離的 git worktree 中啟動 Claude,位於 <repo>/.claude/worktrees/<name>。如果未提供名稱,則會自動產生一個。傳遞 #<number> 或 GitHub 提取請求 URL 以從 origin 擷取該 PR 並從它分支 worktreeclaude -w feature-auth

系統提示旗標

Claude Code 提供四個旗標用於自訂系統提示。所有四個都在互動和非互動模式中運作。
旗標行為範例
--system-prompt取代整個預設提示claude --system-prompt "You are a Python expert"
--system-prompt-file用檔案內容取代claude --system-prompt-file ./prompts/review.txt
--append-system-prompt附加到預設提示claude --append-system-prompt "Always use TypeScript"
--append-system-prompt-file將檔案內容附加到預設提示claude --append-system-prompt-file ./style-rules.txt
--system-prompt--system-prompt-file 互斥。附加旗標可以與任一取代旗標組合。 根據 Claude Code 的預設身份是否仍適合您的工作來選擇。當 Claude 應保持編碼助手身份並同時遵循您的額外規則時,請使用附加旗標:每次呼叫的指示、輸出格式或 -p 指令碼的領域內容。附加會保留預設工具指導、安全指示和編碼慣例,因此您只需提供不同的部分。當表面、身份或權限模型與 Claude Code 不同時,請使用取代旗標,例如管道中沒有人監看的非編碼代理程式。取代會移除整個預設提示,包括工具指導和安全指示,因此您需要負責您的工作仍然需要的任何內容。 這些旗標僅適用於目前的呼叫。對於您可以在專案中切換和共享的持久人物,請使用 output styles。對於 Claude 應始終遵循的專案慣例,請使用 CLAUDE.mdAgent SDK 系統提示指南 涵蓋了更深入的相同決策。

另請參閱