命令字典
Slash 命令、CLI 子命令、Hook 事件、启动参数的字典与演进史。
Slash 命令、CLI 子命令、Hook 事件、启动参数的字典与演进史。
配置 Google Vertex AI 认证和模型
/setup-vertex 是 Claude Code 会话内的 Slash 命令,用于重新打开 Vertex AI 设置向导,让你修改 Google Cloud 凭证、GCP 项目、区域或模型版本绑定,而无需退出当前会话。
向导将结果写入用户设置文件的 env 块,所以你无需手动 export 环境变量。
前置要求(来自官方文档):
| 要求 | 说明 |
|---|---|
| Claude Code 版本 | v2.1.98 或更高(向导功能) |
| X.509 Workload Identity 支持 | v2.1.121 或更高 |
| GCP 账号 | 已启用计费,项目已开启 Vertex AI API |
| 模型访问 | 已在 Vertex AI Model Garden 申请并获批目标模型 |
| gcloud SDK | 已安装(若使用 Application Default Credentials) |
首次运行 claude 时,在登录提示处选择认证方式:
$ claude
# 登录提示出现后:
# → 选择 "3rd-party platform"
# → 选择 "Google Vertex AI"
# → 按向导提示选择认证方式、项目、区域、模型版本
向导会依次:
env 块/setup-vertex
随时在会话中输入该命令,重新打开向导以变更凭证、项目、区域或模型绑定。
若不使用向导,可手动设置以下环境变量:
# 必须:启用 Vertex AI 模式
export CLAUDE_CODE_USE_VERTEX=1
# 必须:区域(global / eu / us / 具体区域如 us-east5)
export CLOUD_ML_REGION=global
# 项目 ID(优先级最低,见下方说明)
export ANTHROPIC_VERTEX_PROJECT_ID=YOUR-PROJECT-ID
可选变量:
# 覆盖 Vertex 端点(自定义网关场景)
export ANTHROPIC_VERTEX_BASE_URL=https://aiplatform.googleapis.com
# 禁用 prompt caching
export DISABLE_PROMPT_CACHING=1
# 启用 1 小时 cache TTL(写入费率更高)
export ENABLE_PROMPT_CACHING_1H=1
# global 区域下,为不支持 global endpoint 的模型单独指定区域
export VERTEX_REGION_CLAUDE_HAIKU_4_5=us-east5
export VERTEX_REGION_CLAUDE_4_6_SONNET=europe-west1
# 启用 MCP tool search(仅 Sonnet 4.5+ 和 Opus 4.5+ 支持)
export ENABLE_TOOL_SEARCH=true
项目 ID 解析优先级(高 → 低):
GCLOUD_PROJECT、GOOGLE_CLOUD_PROJECT、以及 GOOGLE_APPLICATION_CREDENTIALS 指向的凭证文件(三者并列同级,官方未给出彼此之间的相对顺序)> ANTHROPIC_VERTEX_PROJECT_ID > gcloud 配置 / 附加的 Service Account
官方原文:The
GCLOUD_PROJECTandGOOGLE_CLOUD_PROJECTenvironment variables and the credential file referenced byGOOGLE_APPLICATION_CREDENTIALStake precedence over it [ANTHROPIC_VERTEX_PROJECT_ID].
向导将所有配置保存到用户设置文件的 env 块中,不需要在 shell profile 里 export。
gcpAuthRefresh)当 GCP 凭证过期时,可配置自动刷新命令,避免手动重新登录:
{
"gcpAuthRefresh": "gcloud auth application-default login",
"env": {
"ANTHROPIC_VERTEX_PROJECT_ID": "your-project-id"
}
}
.claude/settings.json 中,该命令仅在用户接受 workspace trust 提示后才会执行企业批量部署时强烈建议绑定具体版本,否则模型别名(sonnet、opus)解析到 Claude Code 内置默认值,该默认值可能在项目中尚未启用:
export ANTHROPIC_DEFAULT_OPUS_MODEL='claude-opus-4-8'
export ANTHROPIC_DEFAULT_SONNET_MODEL='claude-sonnet-4-6'
export ANTHROPIC_DEFAULT_HAIKU_MODEL='claude-haiku-4-5@20251001'
# 或覆盖主模型:
export ANTHROPIC_MODEL='claude-opus-4-8'
Vertex AI 默认模型(无绑定时):
| 类型 | 默认值 |
|---|---|
| 主模型 | claude-sonnet-4-5@20250929 |
| 后台小模型 | 与主模型相同(非 Haiku) |
注:Vertex AI 上 Claude Code 的后台任务(如会话标题生成)默认使用主模型,因为 Haiku 不一定在所有项目/区域中启用。
Opus 4.6+、Sonnet 4.6 在 Vertex AI 上支持 1M token 上下文。向导会提供选项;手动配置时在模型 ID 末尾追加 [1m]:
export ANTHROPIC_DEFAULT_SONNET_MODEL='claude-sonnet-4-6[1m]'
最小权限角色:roles/aiplatform.user,包含必须的 aiplatform.endpoints.predict 权限。
| 约束 | 说明 |
|---|---|
/logout 不可用 | Vertex AI 模式下认证由 Google Cloud 凭证接管(官方原文:the /logout command is unavailable) |
| MCP tool search 默认关闭 | MCP 工具定义在启动时全量加载;Sonnet 4.5+ / Opus 4.5+ 可用 ENABLE_TOOL_SEARCH=true 开启;更早版本的模型请求会失败 |
| 模型可用性因区域/端点类型而异 | global、multi-region(eu/us)、单区域支持的模型各不相同 |
gcpAuthRefresh 超时 3 分钟 | 认证未在 3 分钟内完成则超时 |
| 向导不支持交互式凭证命令 | gcpAuthRefresh 只能用浏览器跳转式流程,不能用需要终端交互的命令 |
/setup-vertex(向导) | 手动环境变量 | |
|---|---|---|
| 适用场景 | 个人开发者,单机配置 | CI/CD、企业批量部署 |
| 配置保存位置 | 用户设置文件 env 块 | shell profile / CI secrets |
| 模型可用性检查 | 向导自动验证 | 需手动确认 |
| 变更方式 | 会话内 /setup-vertex 重开向导 | 修改环境变量后重启 |
| 版本要求 | v2.1.98+ | 无版本限制 |
/setup-vertex 即可切换,不用退出重新配置。gcpAuthRefresh + 环境变量实现无人值守的凭证刷新,配合 ANTHROPIC_DEFAULT_*_MODEL 锁定版本,保证所有用户使用相同模型。CLOUD_ML_REGION=global 获得更高可用性,再用 VERTEX_REGION_* 为不支持 global 端点的模型单独指定区域。"Could not load the default credentials":最常见原因是没有运行 gcloud auth application-default login,或 GOOGLE_APPLICATION_CREDENTIALS 指向了不存在的文件。先跑一遍 gcloud auth application-default print-access-token 验证凭证是否正常。
Model 404 / "model not found":在 Vertex AI Model Garden 里申请模型访问后,审批可能需要 24–48 小时。另一常见原因是所选区域/端点不支持该模型。官方原文明确:使用 CLOUD_ML_REGION=global 时若模型不支持 global 端点,报的就是 404(model not found)——在 Model Garden 的 "Supported features" 里确认,再用 ANTHROPIC_MODEL / ANTHROPIC_DEFAULT_HAIKU_MODEL 换支持的模型,或用 VERTEX_REGION_<MODEL_NAME> 为该模型单独指定区域/multi-region。
区域端点下 429 报错:官方原文将 429 归在区域端点场景——确保主模型和后台小模型都在所选区域受支持;或考虑切换到 CLOUD_ML_REGION=global 以获得更好的可用性。注意:global 端点上模型不可用是 404 而非 429(见上条)。
模型别名漂移:不绑定具体版本时,Claude Code 内置默认值在新版本发布后会静默变更,可能导致项目中未启用新版本而报错。生产环境务必设置 ANTHROPIC_DEFAULT_*_MODEL。
MCP 工具在 Vertex AI 上失败:旧版模型(Sonnet 4.5 之前)不接受 tool search 的 beta 请求头,若误设 ENABLE_TOOL_SEARCH=true,所有带工具的请求均会失败。确认模型版本后再启用。
改进向导提示和模型候选项建议