@cloudflare/wrangler

中文文档
1.21.0发布于 2023/02/22MIT OR Apache-2.0CommonJS近 30 天下载 8860

所有事物的命令行界面 Cloudflare 工人

此软件包已被标记为弃用

This package is for Wrangler v1.x and is no longer supported. Please visit https://www.npmjs.com/package/wrangler for Wrangler v2+.

中文使用文档
文档目录17 节
  1. 安装
  2. 安装方式 npm
  3. 安装方式 cargo
  4. 在窗口上安装
  5. 更新
  6. 开始
  7. 高级命令
  8. 👯 generate
  9. 📥 init
  10. 🦀⚙️ build
  11. 🔓 login
  12. 🔧 config
  13. ☁️ publish
  14. 🗂 kv
  15. 👂 dev
  16. 其他文档
  17. 工人场地

{\fn黑体\fs22\bord1\shad0\3ahbe\4ah00\fscx67\fscy66\2chffffff\3ch808080}你这混蛋

说明: 如果你在寻找最新版本的 wrangler 包,访问 https://github.com/cloudflare/works-sdk 互联网档案馆的存檔,存档日期2013-12-21

Banner

crates.io   npm   GitHub Actions - Test Status   GitHub Actions - Linter Status  

wrangler 是一个CLI工具,为有兴趣使用的人设计 云花岗工人。 。 。 .

Wrangler Demo

安装

你有很多选择要安装扳手!

最新版本见 https://github.com/cloudflare/works-sdk 互联网档案馆的存檔,存档日期2013-12-21

安装方式 npm

我们强烈建议你安装 npm 类似节点版本管理器 nvm,这就使全球 node_modules 在您家目录中删除权限问题 npm install -g. 分发包装 npm 经常使用的安装 /usr/lib/node_modules 全球安装( 根) npm 软件包,并运行 npm install -g 作为 root 防止 wrangler 从正确安装.

一旦安装完毕 nvm 并配置了您的系统以使用 nvm 管理节点安装, 运行 :

npm i @cloudflare/wrangler -g

如果您正在运行基于ARM的系统( 如 Raspberry Pi, Pinebook), 您需要使用 cargo 下面列出从源头构建wrangler的安装方法.

指定二进制位置

如果你需要的话 wrangler将二进制设置在非默认位置的 npm 安装器( 例如当使用时) wrangler 在 CI 中,您可以使用下列配置选项指定安装位置:

  • 环境变量: WRANGLER_INSTALL_PATH
  • 国家预防机制配置: wrangler_install_path

指定二进制站点 URL

如果您需要在前提上存储/模拟二进制, 您需要通过提供下列任何一项来指定wrangler应在哪里搜索它们 :

  • 环境变量: WRANGLER_BINARY_HOST
  • 国家预防机制配置: wrangler_binary_host

安装方式 cargo

cargo install wrangler

如果你没有 cargo 或者说 npm 安装后,您需要跟踪这些 补充说明。 。 。 .

在窗口上安装

perl 是箱子打开sl-sys的外部依赖性。如果安装有货物的扳手,则需要安装活塞。 我们测试过 草莓树。如果您通过勺安装 perl,您可能需要运行 scoop install openssl 以获得必要的开口 Dells。 安装 wrangler 时使用 npm 而不是货物是另一个选项 如果你不想安装活塞.

更新

欲了解有关Wrangler更新的信息,点击 这里。 。 。 .

开始

一旦你安装了Wrangler, 旋转和部署你的第一位工人是容易的!

$ wrangler generate my-worker
$ cd my-worker
# update your wrangler.toml with your Cloudflare Account ID
$ wrangler config
$ wrangler publish

高级命令

👯 generate

脚手架项目,包括一个Rust图书馆和Cloudflare Worker的锅炉板代码.

wrangler generate <name> <template> --type=["webpack", "javascript", "rust"]

此命令的所有参数和旗帜都是可选的 :

📥 init

创建骨架 wrangler.toml 中。 这可以作为替代 generate 如果你喜欢自己克隆一个仓库.

wrangler init <name> --type=["webpack", "javascript", "rust"]

此命令的所有参数和旗帜都是可选的 :

  • name: 默认为工作目录的名称
  • type: 默认为 "网络包装"。 。 。 .

🦀⚙️ build

构建您的项目 。 这个命令看着你 wrangler.toml 文件并运行关联的构建步骤 与 "type" 在那边宣布.

此外,您还可以配置不同的 环境。 。 。 .

🔓 login

用您的 Cloudflare 登录授权 Wrangler 。 这将提示您使用 Cloudflare 账户登录页和权限同意页 . 此命令是替代 wrangler config 它使用OAuth标志.

wrangler login --scopes-list --scopes <scopes>

此命令的所有参数和旗帜都是可选的 :

  • scopes-list:列出所有可用的 OAuth 范围,并附有描述.
  • scopes:允许选择您的 OAuth 瞄准镜 .

详情请访问 Wrangler 登录文档。 。 。 .

🔧 config

用 Cloudflare API Token 认证 Wrangler 。 这是一个交互式命令, 将提示您获取您的 API 令牌 :

wrangler config
Enter API token:
superlongapitoken

您也可以提供您的电子邮件和全局 API 密钥( 出于安全考虑, 不推荐 ) :

wrangler config --api-key
Enter email:
[email protected]
Enter global API key:
superlongapikey

你也可以这样 使用环境变量 来配置这些值.

☁️ publish

发布你的工人到Cloudflare。 您的几个键 wrangler.toml 确定您是否向员工发布。 dev subdomain 或您自己的注册域,通过 Cloudflare 代理.

此外,您还可以配置不同的 环境。 。 。 .

发布 Worker 时也可以使用环境变量来处理认证.

# e.g.
CF_API_TOKEN=superlongtoken wrangler publish
# where
# $CF_API_TOKEN -> your Cloudflare API token

CF_API_KEY=superlongapikey [email protected] wrangler publish
# where
# $CF_API_KEY -> your Cloudflare API key
# $CF_EMAIL -> your Cloudflare account email

🗂 kv

与您的工人 KV 商店互动 。 这其实是一组子命令 更多信息请访问 Wrangler KV 文档。 。 。 .

👂 dev

wrangler dev 工作非常相似 与 wrangler preview 但是,它不会打开浏览器预览您的工人,而是会在本地主机上启动一个服务器,在收到的HTTP请求时执行您的工人. 从那里,您可以使用cURL,Postman,您的浏览器,或任何其他HTTP客户端在发布前测试您员工的行为.

您应该从员工目录中运行 wrangler dev, 如果您的员工向后端提出任何请求, 您应该指定主机 --host example.com。 。 。 .

从这里您应该可以发送 HTTP 请求到 localhost:8787 以及任何标题和路径, 你的工人应该如预期的那样执行。 此外,您应该看到控制台.log消息和例外出现在您的终端中 .

👂 Listening on http://localhost:8787
[2020-02-18 19:37:08] GET example.com/ HTTP/1.1 200 OK

此命令的所有参数和旗帜都是可选的 :

  • env: 建设环境
  • host: 测试你工人背后的域。 默认为示例.com
  • ip:ip来听. 本地主机的默认值
  • port:端口听取. 默认为8787

其他文档

有关wrangler或Cloudflare工人的所有信息都位于该区 Cloudflare 工人开发者文档这包括:

  • 使用扳手 命令
  • 响尾蛇 配置
  • 关于工人发展的一般文献
  • 工人工地和KV等所有wrangler特征

工人场地

学习如何使用 wrangler,参见 工人工地快速启动。 。 。 .

版本与发布记录

@cloudflare/wrangler 共发布 79 个版本,首次发布于 2019/06/02;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.21.0latest2023/02/223 年前
1.20.02022/10/044 年前
1.19.132022/09/154 年前
1.19.122022/04/214 年前
1.19.112022/03/224 年前
1.19.102022/03/224 年前

其他发布通道:beta → 1.19.3-rc.1。

关于 @cloudflare/wrangler 的常见问题

@cloudflare/wrangler 是什么?

所有事物的命令行界面 Cloudflare 工人注意:该包已被作者标记为弃用——This package is for Wrangler v1.x and is no longer supported. Please visit https://www.npmjs.com/package/wrangler for Wrangler v2+.

如何安装 @cloudflare/wrangler?

在项目目录运行 npm install @cloudflare/wrangler,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 wrangler、wrangler1,可以用 npx wrangler 直接运行。

@cloudflare/wrangler 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/cloudflare__wrangler 是否存在。

@cloudflare/wrangler 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@cloudflare/wrangler 可以商用吗?

@cloudflare/wrangler 使用 MIT OR Apache-2.0 许可。可在 MIT、Apache-2.0 中任选其一遵守。选择 MIT 时,宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@cloudflare/wrangler 的下载量有多少?

根据 npm 官方下载统计,@cloudflare/wrangler 在 2026/10/10 – 2026/11/08 这 30 天内被下载 8,860 次,日均约 295 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@cloudflare/wrangler 还在维护吗?

最新版本 1.21.0 发布于 2023/02/22(3 年前);至今共发布 79 个版本,其中过去 12 个月发布了 0 个;首次发布于 2019/06/02。作者已将其标记为弃用,新项目建议寻找替代方案。