Wrangler 常用命令列表

 

Wrangler 常用命令列表
1. 项目管理与初始化

wrangler init [name]



作用： 初始化一个新的Cloudflare Workers项目。


用法： wrangler init my-new-worker


小顾提示： 这是您开始新项目的第一步。它会创建一个包含 src/index.js (或 src/index.ts) 和 wrangler.toml 文件的基本结构。


wrangler generate [name] [template_url] (已废弃，推荐使用 init)



作用： 从模板生成新的Workers项目。


小顾提示： 这个命令在较新版本中已被 wrangler init 替代，init 现在也支持 --template 参数来指定模板。例如：wrangler init my-worker --template https://github.com/cloudflare/worker-template
2. 开发与调试

wrangler dev [script]



作用： 在本地启动一个开发服务器，模拟Cloudflare Workers环境，方便您进行本地调试。


用法： wrangler dev (会在当前项目目录下启动，或者指定 script 文件)


小顾提示： 这是开发Workers时最常用的命令！每次修改代码后，保存即可看到实时效果，极大地提高了开发效率。它会提供一个本地URL，通常是 http://localhost:8787。


wrangler tail



作用： 实时查看部署在Cloudflare上的Worker的日志输出。


用法： wrangler tail


小顾提示： 部署到生产环境后，这个命令是您调试Worker行为、查看请求响应、检查错误日志的利器。就像 tail -f 看文件一样实时。


wrangler pages dev [directory] (用于Cloudflare Pages) / wrangler pages deploy [directory]



作用： 针对Cloudflare Pages项目的本地开发和部署。Cloudflare Pages是另一个基于Workers的静态网站托管服务，通常与Workers结合使用。


用法： wrangler pages dev public (在 public 目录下启动Pages开发服务器)


小顾提示： 如果您的项目是静态网站或单页应用，并部署在Cloudflare Pages上，这些命令会非常有用。
3. 部署与发布

wrangler deploy [script]



作用： 将您的Workers代码部署到Cloudflare。


用法： wrangler deploy (部署当前项目配置的Workers)


小顾提示： 这是将您的成果推向世界的关键命令！首次部署时，Wrangler可能会引导您进行一些配置（如Worker名称、Routes等）。


wrangler deploy --name <worker-name>



作用： 部署一个特定名称的Worker。


小顾提示： 当您在同一个项目中有多个Worker，或者希望部署到不同的名称时使用。


wrangler deploy --env <environment-name>



作用： 部署到特定的环境（如 staging、production）。需要在 wrangler.toml 中配置不同的环境。


小顾提示： 专业的开发流程中，通常会有不同的环境来测试和发布，这个命令让环境管理变得很简单。
4. 配置与认证

wrangler login



作用： 登录您的Cloudflare账号。Wrangler会尝试通过OAuth (浏览器认证) 或检测 CLOUDFLARE_API_TOKEN 环境变量进行认证。


用法： wrangler login


小顾提示： 如我们之前所讨论，在VPS上，更推荐通过设置 CLOUDFLARE_API_TOKEN 环境变量来自动认证，然后 wrangler login 会提示您已登录。


wrangler logout



作用： 登出Cloudflare账号，清除本地认证信息。


用法： wrangler logout


wrangler whoami



作用： 显示当前登录的Cloudflare账号信息。


用法： wrangler whoami


小顾提示： 这是一个很好的命令，可以快速验证您是否已成功登录。
5. Workers/KV/D1/R2等资源管理

wrangler kv:namespace create <name>



作用： 创建一个KV Namespace。


用法： wrangler kv:namespace create MY_NAMESPACE


小顾提示： KV是Cloudflare的键值存储服务，非常适合存储小量数据。


wrangler kv:key put <namespace-id> <key> <value> / wrangler kv:key get <namespace-id> <key>



作用： 向KV Namespace中写入/读取键值对。


小顾提示： 可以直接在命令行操作KV数据。


wrangler r2 bucket create <name>



作用： 创建一个R2 Bucket (兼容S3的对象存储)。


用法： wrangler r2 bucket create my-r2-bucket


小顾提示： R2是Cloudflare的对象存储服务，如果您需要存储大量文件，这个是首选。


wrangler d1 create <name>



作用： 创建一个D1数据库 (基于SQLite的无服务器数据库)。


用法： wrangler d1 create my-d1-database


小顾提示： D1是Cloudflare新推出的数据库服务，让Workers也能拥有持久化数据库能力。


wrangler d1 execute <database-name> --file <sql-file>



作用： 在D1数据库上执行SQL文件。


小顾提示： 方便您对D1数据库进行数据操作或结构调整。


wrangler secret put <key>



作用： 将敏感信息（如API密钥）作为加密的Secret存储在Worker中，Worker代码可以直接访问，但这些Secret不会暴露在代码仓库中。


用法： wrangler secret put MY_API_KEY (然后会提示您输入值)


小顾提示： 这是管理Worker敏感配置的最佳实践，极大提升安全性。
6. 其他实用命令

wrangler build



作用： 手动构建Workers项目（通常在 wrangler deploy 时会自动执行）。


小顾提示： 如果您想在部署前单独检查构建过程，可以使用此命令。


wrangler publish (已废弃，推荐使用 deploy)



作用： 早期版本用于部署，现在推荐使用 wrangler deploy。


wrangler --version



作用： 显示Wrangler的版本信息。


wrangler --help 或 wrangler [command] --help



作用： 查看Wrangler的整体帮助信息，或特定命令的帮助信息。


小顾提示： 当您不确定某个命令的用法时，这是一个非常好的求助方式。