> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。
> [English](./README.en.md) · [原始项目](https://github.com/cloudflare/workers-sdk) · [上游 README](https://github.com/cloudflare/workers-sdk/blob/HEAD/README.md)
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
Cloudflare Workers SDK
Cloudflare Workers 让你能够在全球范围内即时部署无服务器(serverless)代码,以获得出色的性能、可靠性和可扩展性。
参与贡献
·
提交 Issue
·
加入 Discord
## 快速入门
若要快速开始一个新项目,请运行以下命令:
```bash
npm create cloudflare@latest
# or
pnpm create cloudflare@latest
# or
yarn create cloudflare@latest
```
更多信息,请访问我们的[入门指南](https://developers.cloudflare.com/workers/get-started/guide/) guide。
## 文档
请访问官方 Workers 文档[此处](https://developers.cloudflare.com/workers/).
- [入门指南](https://developers.cloudflare.com/workers/get-started/guide/)
- [Workers 工作原理](https://developers.cloudflare.com/workers/reference/how-workers-works/)
- [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/)
- [可观测性(Observability)](https://developers.cloudflare.com/workers/observability/)
- [平台](https://developers.cloudflare.com/workers/platform/)
## 目录
| 包 | 说明 | 链接 |
| ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| [`wrangler`](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler) | 用于构建 [Cloudflare Workers](https://workers.cloudflare.com/). 的命令行工具 | [文档](https://developers.cloudflare.com/workers/wrangler/) |
| [`create-cloudflare` (C3)](https://github.com/cloudflare/workers-sdk/tree/main/packages/create-cloudflare) | 用于在 Cloudflare 上创建和部署新应用的 CLI。 | [文档](https://developers.cloudflare.com/pages/get-started/c3/) |
| [`miniflare`](https://github.com/cloudflare/workers-sdk/tree/main/packages/miniflare) | 用于开发和测试 Cloudflare Workers 的模拟器,由 [workerd](https://github.com/cloudflare/workerd) 驱动 | [文档](https://miniflare.dev) |
| [`chrome-devtools-patches`](https://github.com/cloudflare/workers-sdk/tree/main/packages/chrome-devtools-patches) | Cloudflare 对 Chrome DevTools 的分支,用于检查本地或远程 Workers | |
| [`pages-shared`](https://github.com/cloudflare/workers-sdk/tree/main/packages/pages-shared) | 在内部用于驱动 Wrangler 和 Cloudflare Pages,包含这些客户端之间共享的全部代码。 | |
## Beta 版本
Beta 版本由 [pkg.pr.new](https://github.com/stackblitz-labs/pkg.pr.new) 工具生成,并在每次推送到 `main` 分支的提交时更新。
> [!Warning]
> 这些 Beta 版本会随时间不断更新,因此不适合作为项目的稳定版本(应改用正式发布的 npm 版本)。它们仅应用于快速测试尚未发布的功能/修复。
可用的 Beta 版本如下所列。
create-cloudflare
```
npm i https://pkg.pr.new/create-cloudflare@main
```
@cloudflare/kv-asset-handler
```
npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@main
```
miniflare
```
npm i https://pkg.pr.new/miniflare@main
```
@cloudflare/pages-shared
```
npm i https://pkg.pr.new/@cloudflare/pages-shared@main
```
@cloudflare/unenv-preset
```
npm i https://pkg.pr.new/@cloudflare/unenv-preset@main
```
@cloudflare/vite-plugin
```
npm i https://pkg.pr.new/@cloudflare/vite-plugin@main
```
@cloudflare/vitest-pool-workers
```
npm i https://pkg.pr.new/@cloudflare/vitest-pool-workers@main
```
@cloudflare/workers-editor-shared
```
npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@main
```
wrangler
```
npm i https://pkg.pr.new/wrangler@main
```
## 参与贡献
我们欢迎新的贡献者!详情请参阅 [`CONTRIBUTING.md`](/CONTRIBUTING.md) 指南。
## 社区
欢迎加入官方 [Cloudflare Discord](https://discord.cloudflare.com/),与其他开发者交流、提问或了解更多信息。
## 链接
- [项目看板](https://github.com/orgs/cloudflare/projects/1)
- [讨论](https://github.com/cloudflare/workers-sdk/discussions)