4.4 命令幫助系統
Claude Code 提供了完善的幫助系統,幫助您快速查詢和理解命令的用法。掌握幫助系統可以大大提高您使用 Claude Code 的效率。
幫助系統的組成
Claude Code 的幫助系統包括以下幾個部分:
- CLI 幫助 :透過
--help標誌獲取命令列幫助 - 互動式幫助 :透過
/help斜槓命令獲取互動式幫助 - 命令自動完成 :在輸入命令時提供自動完成建議
- 錯誤提示 :在命令執行失敗時提供有用的錯誤資訊和建議
CLI 帮助
使用 --help 标志
大多數 CLI 命令和標誌都支援 --help 標誌,可以顯示詳細的幫助資訊。
基本用法
claude --help
這會顯示 Claude Code 主命令的幫助資訊,包括所有可用的子命令和標誌。
子命令帮助
bash
bash
claude update --help
这会显示 `update` 子命令的详细帮助信息。
#### 标志帮助
claude --help --model
這會顯示 --model 標誌的詳細說明。
幫助資訊的內容
幫助資訊通常包含以下內容:
- 命令描述 :命令或標誌的簡要說明
- 語法格式 :命令的正確使用格式
- 引數說明 :各個引數的含義和用法
- 使用示例 :實際的使用示例
- 相關命令 :相關的其他命令或標誌
- 注意事項 :使用時需要注意的事項
交互式帮助
使用 /help 斜杠命令
在互動式會話中,輸入 /help 可以顯示可用的斜槓命令列表。
基本用法
bash
/help
這會顯示所有可用的斜槓命令及其簡要說明。
命令詳細幫助
某些斜槓命令也支援獲取詳細幫助:
bash
/help plugin
這會顯示 `/plugin` 命令的詳細用法。
### 互動式幫助的特點
互動式幫助具有以下特點:
* **實時更新** :幫助資訊會根據當前環境動態更新
* **上下文相關** :顯示與當前上下文相關的命令
* **分類顯示** :命令按照功能分類顯示,便於查詢
* **示例豐富** :提供大量實際使用示例
## 命令自动完成
### CLI 自动完成在命令列中,Claude Code 支援命令和引數的自動完成。
使用方法
自动完成的内容
- 命令名稱
- 子命令名稱
- 標誌名稱
- 檔案路徑
- 引數值
互動式自動完成
在互動式會話中,Claude Code 也支援自動完成。
使用方法
交互式自动完成的内容
- 斜槓命令
- 檔案路徑
- 命令引數
- 歷史命令
错误提示和建议
错误提示的内容
當命令執行失敗時,Claude Code 會提供詳細的錯誤資訊,包括:
- 錯誤型別 :錯誤的類別(引數錯誤、許可權錯誤、網路錯誤等)
- 錯誤詳情 :具體的錯誤描述
- 錯誤位置 :錯誤發生的位置(檔名、行號等)
- 建議方案 :修復錯誤的建議
错误提示的示例
bash
$ claude --invalid-flag
Error: Unknown flag: --invalid-flag
Did you mean: --verbose?
$ claude -r "invalid-session-id"
Error: Session not found: invalid-session-id
Available sessions:
- abc123: "Review PR #123"
- def456: "Fix bug #456"