命令帮助系统

掌握 Claude Code 的帮助系统快速查找命令用法

概述

Claude Code 提供了完善的帮助系统,帮助您快速查找和理解命令的用法。帮助系统包括:

  • CLI 帮助:通过 --help 标志获取命令行帮助
  • 交互式帮助:通过 /help 斜杠命令获取交互式帮助
  • 命令自动完成:在输入命令时提供自动完成建议
  • 错误提示:在命令执行失败时提供有用的错误信息和建议

CLI 帮助

使用 --help 标志

大多数 CLI 命令和标志都支持 --help 标志:

# 主命令帮助
claude --help

# 子命令帮助
claude update --help

# 标志帮助
claude --help --model

帮助信息内容

内容说明
命令描述命令或标志的简要说明
语法格式命令的正确使用格式
参数说明各个参数的含义和用法
使用示例实际的使用示例
相关命令相关的其他命令或标志
注意事项使用时需要注意的事项

交互式帮助

使用 /help 斜杠命令

在交互式会话中获取帮助:

# 显示所有可用的斜杠命令
/help

# 显示特定命令的详细帮助
/help plugin

交互式帮助特点

特点说明
实时更新帮助信息会根据当前环境动态更新
上下文相关显示与当前上下文相关的命令
分类显示命令按照功能分类显示,便于查找
示例丰富提供大量实际使用示例

命令自动完成

CLI 自动完成

在命令行中支持自动完成:

  • 命令名称
  • 子命令名称
  • 标志名称
  • 文件路径
  • 参数值

交互式自动完成

在交互式会话中支持自动完成:

  • 斜杠命令
  • 文件路径
  • 命令参数
  • 历史命令

错误提示和建议

错误提示内容

内容说明
错误类型错误的类别(参数错误、权限错误、网络错误等)
错误详情具体的错误描述
错误位置错误发生的位置(文件名、行号等)
建议方案修复错误的建议

错误提示示例

$ 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"

On this page