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"