跳到主要内容

cf 公开测试版现已发布,完整映射整个 Cloudflare API。

阅读发布公告
迁移与参考参考

环境变量

控制 cf 的认证、目标选择、输出与遥测的环境变量参考。

这些变量在运行 cf 的环境中设置,用于配置 CLI 本身,而不是部署后的 Worker 可用的环境变量或密钥。

认证与目标

变量 默认值 作用
CLOUDFLARE_API_TOKEN 未设置时使用选中的 OAuth profile 用该 token 认证 API 命令,适用于 CI 与自动化
CLOUDFLARE_ACCOUNT_ID 未设置时使用项目配置、已保存的选择或可访问账号 为账号作用域的命令选择账号,优先于 cloudflare.config.ts 中的 accountId
CLOUDFLARE_ZONE_ID 未设置时 zone 作用域命令需要显式指定 提供默认 zone ID 或域名,--zone / -z 优先
CLOUDFLARE_API_BASE_URL 所选合规区域的 API 地址 覆盖 API 端点,只应指向你信任的地址
CLOUDFLARE_COMPLIANCE_REGION public 选择合规区域,接受 public、fedramp_high、fedramp-high
CLOUDFLARE_ACCESS_CLIENT_ID 未设置 连接受 Access 保护的 Worker 时使用的服务令牌 ID
CLOUDFLARE_ACCESS_CLIENT_SECRET 未设置 上述服务令牌的密钥
CLOUDFLARE_REGISTRY_PATH cf 配置目录中的 registry 与 Wrangler、Miniflare 共享的本地开发注册表路径
TUNNEL_MANAGEMENT_TOKEN 未设置 为 cf tunnels tail 提供已有的管理令牌

输出与进度

变量 默认值 作用
CF_QUIET 未设置,显示交互式进度 设为 1 抑制动画式 API 进度与终端进度,但不抑制命令结果
CF_FORCE_OSC_PROGRESS 未设置 设为 1 在未识别的兼容终端中启用进度显示
CF_NO_OSC_PROGRESS 未设置 设为 1 关闭终端标签页或任务栏中的进度
NO_COLOR 未设置,标准输出为终端时使用颜色 设为任意值即禁用彩色输出与动画进度
FORCE_COLOR 未设置 设为非 0 值在没有终端时也启用样式输出,NO_COLOR 优先
DEBUG 未设置 设为非空值以显示额外诊断信息,包括错误堆栈

非交互与遥测

变量 默认值 作用
CI 未设置,cf 也会自行探测 CI 环境 设为 true 以避免交互式提示,提示会使用默认值或在必须回答时失败
CF_SEND_TELEMETRY 未设置,使用已保存的偏好或默认值 设为 true / 1 启用匿名使用遥测,false / 0 关闭
WRANGLER_SEND_METRICS 未设置 在未设置 CF_SEND_TELEMETRY 时生效
DO_NOT_TRACK 未设置 设为 1 关闭遥测,即使 CF_SEND_TELEMETRY 已启用

从 .env 加载

API 命令会从当前目录的 .env 读取:

  • CLOUDFLARE_API_TOKEN
  • CLOUDFLARE_ACCOUNT_ID
  • CLOUDFLARE_ZONE_ID
  • CLOUDFLARE_COMPLIANCE_REGION
  • CLOUDFLARE_ACCESS_CLIENT_ID
  • CLOUDFLARE_ACCESS_CLIENT_SECRET

cf 只读取 .env,不读取 .env.local 或 .env.<MODE>。已在环境中设置的变量会覆盖文件中的值。以 --local 运行的命令不读取该文件;cf deploy、cf previews deploy、cf workers versions create 与 cf workers triggers deploy 只在构建结束后读取它。