Claude Code CLI 完整命令文档

姝然_9527
139 阅读11分钟

Claude Code CLI 完整命令文档

目录

基础命令

claude

启动 Claude Code 交互式会话。

claude [选项]

claude --version

显示 Claude Code 版本信息。

claude --version
claude -v

claude --help

显示帮助信息。

claude --help
claude -h

命令行选项

配置文件选项

选项说明
-c, --config <路径>指定配置文件路径
--config-dir <目录>指定配置目录

模型选项

选项说明
-m, --model <模型>指定要使用的 Claude 模型
可选项：
- claude-3-opus-20240229
- claude-3-sonnet-20240229
- claude-3-haiku-20240307

项目选项

选项说明
-p, --project <名称>指定项目名称
--project-dir <目录>指定项目目录

会话选项

选项说明
-s, --session <会话ID>指定会话 ID
--new-session创建新会话
--resume恢复上一个会话

日志选项

选项说明
-d, --debug启用调试模式
--log-file <文件>指定日志文件路径
--log-level <级别>设置日志级别 (debug, info, warn, error)

认证选项

选项说明
--api-key <密钥>直接提供 API 密钥
--check-auth检查认证状态

Slash 命令

文件和目录操作

/add-dir <目录>

作用：添加目录到工作区

示例：

/add-dir src/components

说明：将指定目录添加到 Claude Code 的工作区，使其内的文件可被访问和操作。

/add-file <文件>

作用：添加文件到工作区

示例：

/add-file README.md
/add-file package.json

说明：将指定文件添加到工作区，使其可被读取和编辑。

/remove-dir <目录>

作用：从工作区移除目录

示例：

/remove-dir temp

说明：从工作区移除目录，Claude Code 将不再访问该目录及其内容。

/remove-file <文件>

作用：从工作区移除文件

示例：

/remove-file .env

说明：从工作区移除文件，保护敏感信息或不需要的文件。

/ls

作用：列出工作区中的文件

示例：

/ls

说明：显示当前工作区中的所有文件和目录。

/pwd

作用：显示当前工作目录

示例：

/pwd

说明：显示当前的工作目录路径。

/cd <目录>

作用：更改当前目录

示例：

/cd src

说明：切换当前工作目录到指定路径。

会话管理

/new

作用：开始新会话

示例：

/new

说明：创建一个新的对话会话，之前的上下文将被清除。

/save <文件名>

作用：保存当前会话

示例：

/save project-setup

说明：将会话保存到文件，便于后续加载或分享。

/load <文件名>

作用：加载会话

示例：

/load project-setup

说明：加载之前保存的会话，恢复对话上下文。

/sessions

作用：列出所有会话

示例：

/sessions

说明：显示所有保存的会话列表。

/rename <新名称>

作用：重命名当前会话

示例：

/rename bug-fix-session

说明：为当前会话设置新的名称。

/share

作用：生成会话分享链接

示例：

/share

说明：生成一个可以分享会话内容的链接。

成本和用量

/cost

作用：显示当前会话的 API 使用成本

示例：

/cost

说明：显示当前会话中使用的 API 调用所产生的费用估算。

/usage

作用：显示详细的用量统计

示例：

/usage

说明：显示详细的 API 使用统计信息，包括 token 数量、请求次数等。

/token-count

作用：显示当前消息和对话的 token 数量

示例：

/token-count

说明：显示当前消息和整个对话的 token 数量统计。

配置和设置

/config

作用：查看和修改配置

示例：

/config

说明：打开配置界面，可以查看和修改各种设置选项。

/settings

作用：打开设置界面

示例：

/settings

说明：打开 Claude Code 的设置界面。

/prefs

作用：打开首选项

示例：

/prefs

说明：打开首选项设置。

/mcp

作用：管理 MCP 服务器

示例：

/mcp

说明：管理 MCP（Model Context Protocol）服务器的配置。

/custom-skills

作用：管理自定义技能

示例：

/custom-skills

说明：查看、添加或删除自定义技能。

代码和项目

/build

作用：构建项目

示例：

/build

说明：执行项目的构建命令（根据项目类型自动选择）。

/test

作用：运行测试

示例：

/test

说明：运行项目的测试套件。

/lint

作用：运行代码检查

示例：

/lint

说明：运行代码检查工具（如 ESLint、Pylint 等）。

/commit

作用：创建 git 提交

示例：

/commit

说明：自动创建 git 提交，包含更改的摘要。

/pr

作用：创建或查看拉取请求

示例：

/pr

说明：创建新的拉取请求或查看现有 PR。

/review

作用：代码审查

示例：

/review

说明：对代码进行审查，提供改进建议。

/security-review

作用：安全审查

示例：

/security-review

说明：对代码进行安全审查，识别潜在的安全问题。

/refactor <描述>

作用：代码重构

示例：

/refactor 将重复代码提取为函数

说明：根据描述对代码进行重构。

/document

作用：生成文档

示例：

/document

说明：为代码生成文档注释。

搜索和查找

/find <模式>

作用：在工作区中查找文件

示例：

/find *.js
/find **/*.test.ts

说明：使用 glob 模式查找文件。

/grep <模式>

作用：在文件中搜索内容

示例：

/grep "function calculate"
/grep -i "TODO"

说明：在文件中搜索匹配的文本内容。

/ag <模式>

作用：使用 ag (the silver searcher) 搜索

示例：

/ag "import React"

说明：使用 ag 工具进行快速搜索。

/rg <模式>

作用：使用 ripgrep 搜索

示例：

/rg "class User"

说明：使用 ripgrep 工具进行快速搜索。

帮助和文档

/help

作用：显示帮助信息

示例：

/help

说明：显示 Claude Code 的帮助信息。

/commands

作用：列出所有可用命令

示例：

/commands

说明：列出当前环境中所有可用的命令。

/docs

作用：打开文档

示例：

/docs

说明：打开 Claude Code 文档。

/examples

作用：显示使用示例

示例：

/examples

说明：显示使用示例和最佳实践。

/tips

作用：显示使用技巧

示例：

/tips

说明：显示使用技巧和快捷方式。

系统操作

/clear

作用：清屏

示例：

/clear

说明：清除终端屏幕内容。

/exit

作用：退出 Claude Code

示例：

/exit

说明：退出当前会话。

/quit

作用：退出 Claude Code

示例：

/quit

说明：退出当前会话（同 /exit）。

/restart

作用：重启 Claude Code

示例：

/restart

说明：重启 Claude Code 应用程序。

/update

作用：检查并安装更新

示例：

/update

说明：检查是否有新版本并安装更新。

/version

作用：显示版本信息

示例：

/version

说明：显示当前 Claude Code 版本。

网络和资源

/curl <URL>

作用：执行 HTTP 请求

示例：

/curl https://api.github.com/user

说明：使用 curl 执行 HTTP 请求。

/fetch <URL>

作用：获取网页内容

示例：

/fetch https://example.com

说明：获取并显示网页内容。

/download <URL> <文件>

作用：下载文件

示例：

/download https://example.com/file.zip archive.zip

说明：从 URL 下载文件到本地。

命令执行

/batch <文件>

作用：从文件批量执行命令

示例：

/batch commands.txt

** 说明 ** ：从文件中读取并批量执行命令。

/alias <名称> <命令>

** 作用 **：创建命令别名

** 示例 **：

/alias ll ls -la

** 说明 **：为常用命令创建别名。

/unalias <名称>

** 作用 **：删除别名

** 示例 **：

/unalias ll

** 说明 **：删除已创建的别名。

提示词管理

/prompts

** 作用 **：管理提示词模板

** 示例 **：

/prompts

** 说明 **：查看、创建和管理提示词模板。

/save-prompt <名称>

** 作用 **：保存当前提示词

** 示例 **：

/save-prompt debug-template

说明：将当前提示词保存为模板。

/load-prompt <名称>

作用：加载提示词模板

示例：

/load-prompt debug-template

说明：加载已保存的提示词模板。

开发工具

/dev-server

作用：启动开发服务器

示例：

/dev-server

说明：启动项目的开发服务器。

/build-watch

作用：监听构建

示例：

/build-watch

说明：监听文件变化并自动构建。

/test-watch

作用：监听测试

示例：

/test-watch

说明：监听文件变化并自动运行测试。

/debug

作用：启用调试模式

示例：

/debug

说明：启用调试模式，显示更多信息。

高级功能

自定义技能

Claude Code 支持创建和使用自定义技能，通过 /custom-skills 命令管理。

主要特性：

  • 创建可重复使用的技能
  • 集成外部工具和 API
  • 自定义命令和参数
  • 技能共享和导入

使用示例：

/custom-skills create "Deploy to Production" "脚本路径/deploy.sh"

MCP 服务器集成

支持多种 MCP（Model Context Protocol）服务器，通过 /mcp 命令配置和管理。

支持的 MCP 服务器：

  • 文件系统服务器
  • 数据库服务器
  • API 集成服务器
  • 自定义 MCP 服务器

配置示例：

{
  "mcpServers": {
    "database": {
      "command": "mcp-server-sqlite",
      "args": ["--db-path", "data.db"]
    }
  }
}

环境变量

支持以下环境变量：

环境变量说明示例
ANTHROPIC_API_KEYClaude API 密钥sk-ant-...
ANTHROPIC_MODEL默认模型claude-3-opus-20240229
ANTHROPIC_MAX_TOKENS最大 token 数4096
ANTHROPIC_TEMPERATURE温度参数0.7
CLAUDE_CONFIG_DIR配置目录/path/to/config
CLAUDE_DEBUG启用调试true
CLAUDE_LOG_LEVEL日志级别debug

Hooks

Claude Code 支持配置 hooks，在特定事件时执行自定义脚本。

支持的 Hooks：

  • before-command - 执行命令前
  • after-command - 执行命令后
  • on-error - 发生错误时
  • on-exit - 退出时

配置示例：

{
  "hooks": {
    "before-command": "echo 'Starting command...'",
    "after-command": "echo 'Command completed.'"
  }
}

配置文件

配置文件位置

配置文件路径因操作系统而异：

操作系统配置文件路径
Windows%APPDATA%\Claude\claude.json
macOS~/Library/Application Support/Claude/claude.json
Linux~/.config/Claude/claude.json

配置示例

{
  "apiKey": "sk-ant-...",
  "model": "claude-3-opus-20240229",
  "maxTokens": 4096,
  "temperature": 0.7,
  "debug": false,
  "logLevel": "info",
  "projectDir": ".",
  "ignoredFiles": [
    ".git",
    "node_modules",
    "*.log",
    "*.tmp",
    "dist",
    "build",
    ".env"
  ],
  "sessionTimeout": 3600,
  "autoSave": true,
  "saveInterval": 300,
  "hooks": {
    "before-command": "",
    "after-command": ""
  },
  "mcpServers": {},
  "customSkills": {},
  "aliases": {
    "ll": "ls -la",
    "gs": "git status"
  },
  "theme": "dark",
  "language": "zh-CN"
}

配置选项说明

选项类型说明默认值
apiKeystringClaude API 密钥-
modelstring使用的模型claude-3-opus-20240229
maxTokensnumber最大 token 数4096
temperaturenumber生成文本的随机性 (0-1)0.7
debugboolean启用调试模式false
logLevelstring日志级别info
projectDirstring项目目录.
ignoredFilesstring[]忽略的文件模式见示例
sessionTimeoutnumber会话超时时间（秒）3600
autoSaveboolean自动保存会话true
saveIntervalnumber自动保存间隔（秒）300
themestring主题 (dark/light)dark
languagestring界面语言en

使用示例

启动新项目会话

# 使用项目目录启动
claude --project-dir ./my-project --new-session

# 指定项目名称和模型
claude -p "web-app" -m claude-3-opus-20240229

使用特定配置

# 使用自定义配置文件
claude -c ~/configs/claude-web.json

# 使用特定配置目录
claude --config-dir ~/configs/claude/

调试模式

# 启用调试模式
claude --debug

# 调试模式并指定日志文件
claude -d --log-file debug.log --log-level debug

恢复会话

# 恢复上一个会话
claude --resume

# 指定会话 ID 恢复
claude -s "session-123456"

# 创建新会话
claude --new-session

使用环境变量

# 设置 API 密钥
export ANTHROPIC_API_KEY="sk-ant-..."

# 设置默认模型
export ANTHROPIC_MODEL="claude-3-opus-20240229"

# 启动 Claude Code
claude

常用命令组合

# 开发模式：调试 + 监听构建
claude --debug --project-dir . --session dev-session

# 快速模式：使用 Haiku 模型进行快速查询
claude -m claude-3-haiku-20240307

# 生产模式：使用 Opus 模型处理复杂任务
claude -m claude-3-opus-20240229 --log-level warn

最佳实践

1. 安全管理 API 密钥

  • 不要将 API 密钥硬编码在配置文件中
  • 使用环境变量 ANTHROPIC_API_KEY
  • 定期轮换 API 密钥

2. 优化成本

  • 频繁任务使用 Haiku 模型
  • 复杂任务使用 Opus 模型
  • 定期使用 /cost 检查费用
  • 设置 token 限制避免意外费用

3. 提高生产力

  • 创建常用别名 /alias
  • 保存常用提示词模板 /save-prompt
  • 使用 /batch 批量执行重复任务
  • 定期保存重要会话 /save

4. 保护敏感信息

  • 使用 /remove-file 排除敏感文件
  • 配置 ignoredFiles 自动忽略
  • 不要分享包含敏感信息的会话

5. 自定义工作流程

  • 创建自定义技能处理重复任务
  • 配置 hooks 自动化流程
  • 使用 MCP 集成外部工具

常见问题

Q: 如何查看所有可用的 slash 命令？

A: 使用 /commands 或 /help 命令。

Q: 如何保护我的 API 密钥？

A: 使用环境变量 ANTHROPIC_API_KEY 而不是保存在配置文件中。

Q: 如何减少 API 使用成本？

A: 使用 /cost 监控费用，对简单任务使用 Haiku 模型，设置合理的 token 限制。

Q: 如何排除某些文件或目录？

A: 使用 /remove-file 或 /remove-dir 命令，或在配置文件中设置 ignoredFiles。

Q: 如何恢复意外退出的会话？

A: 使用 claude --resume 或指定会话 ID 启动。

注意事项

  1. 版本差异：某些命令可能只在特定版本的 Claude Code 中可用
  2. 扩展性：实际命令列表可能因安装的技能和插件而异
  3. 实时帮助：建议使用 /commands 命令查看当前环境中所有可用命令
  4. 命令帮助：使用 /help <命令> 获取特定命令的详细帮助
  5. 安全：不要将敏感信息（如密码、私钥）添加到工作区或会话中

获取更多帮助

avatar
文章
阅读
粉丝