# @cloudhal/cloudflare 中文文档

规范地址：https://npmcn.com/package/%40cloudhal/cloudflare/

版本：0\.6\.5
npm 元数据更新时间：2026-11-08T22:22:15.785Z
中文译文更新时间：2026-11-10T03:44:42.686Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cloudhal/cloudflare
原文对照：https://npmcn.com/package/%40cloudhal/cloudflare/?lang=original
项目主页：https://cloudhal.dev/
源码仓库：https://github.com/cloudhal-dev/cloudhal

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：166 kB，35 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24
- 运行依赖：9 个
- 首次发布：2026-10-20T10:50:29.367Z
- 最新版本发布：2026-11-08T22:22:15.488Z
- 近 30 天下载量：4053（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：26（近 12 个月 26 个）

## 中文简介

Cloudflare上的 Cloudhal: 管理员(API, 认证人, MCP, Studio) over D1 + R2

## 安装

```sh
npm install @cloudhal/cloudflare
```

也可以使用：`pnpm add @cloudhal/cloudflare`、`yarn add @cloudhal/cloudflare`、`bun add @cloudhal/cloudflare`

## README

# @ cloudhal/ cloudflare (英语)

云华 **行政人员** (ADR-0012):工作室(静态资产),HTTP API,Better Auth on D1,MCP端点和一个源头的推/推端点,在部署的D1数据库和R2桶上. 每次出版/回滚后,就清除 **工地工人**边缘缓存通过 `SITE` 服务约束.

```ts
// worker.ts — generated by `cloudhal deploy`
import "@cloudhal/cloudflare/workerd-prelude"; // must stay first (zod init order, see the module)
import { createAdminWorker } from "@cloudhal/cloudflare/admin";
import skills from "./skills.ts";
export default createAdminWorker({ skills });
```

| 装订/ 秘密 | 目的 |
| --- | --- |
| `DB` (D1级), `BLOBS` (R2级) | 站点图表、快照、认证、审计 |
| `ASSETS` | 已建演播室 (`not_found_handling: single-page-application`, (中文(简体) ), `run_worker_first` 页:1 `/api/*`, (中文(简体) ), `/mcp`, (中文(简体) ), `/.well-known/*`(中文(简体) ) |
| `SITE` (服务) | 站点工人,用于缓存清理 |
| `BETTER_AUTH_SECRET`, (中文(简体) ), `MCP_STATE_KEY` | 会话; 签名的核准状态 |
| `CLOUDHAL_PREVIEW_SECRET`, (中文(简体) ), `CLOUDHAL_PURGE_TOKEN` | 与现场工人共享 |
| `CLOUDHAL_DEPLOY_TOKEN` | `cloudhal push` 编号 : `pull` |
| `CLOUDHAL_SIGNUP` | `first-user` (默认——只有第一个账户,所有者可以注册),, `closed` 或者说 `open` |

工地工人本身是该项目的Astro建筑(Astro)`@cloudhal/astro-renderer/cloudflare-entry`) (中文(简体) ). 两者均由 `@cloudhal/cli` (单位:千美元)`cloudhal deploy`, (中文(简体) ), `test/cloudflare*.test.ts` (关于工人).

## 游乐场工人(RFC-0036)

`@cloudhal/cloudflare/playground` 管理一个公共游乐场:每个游客在自己的SQLite支持的可持久物体中获得一个一次性Cloudhal(`PlaygroundSite`),种子在第一次使用后被删除,在最后一次请求后一小时被删除(最多2小时),或者一次被重置.

```ts
// worker.ts in the deploying repo (e.g. cloudhal-dev/try)
import "@cloudhal/cloudflare/workerd-prelude";
import { handle } from "@astrojs/cloudflare/handler";
import { serveMedia, withRequestStore } from "@cloudhal/astro-renderer/runtime";
import { createPlaygroundWorker } from "@cloudhal/cloudflare/playground";

const playground = createPlaygroundWorker({
  deployUrl: "https://cloudhal.dev/docs/deploy",
  seed: async (store) => ({ siteId: (await seedDemo(store)).id }),
  render: (request, { store, siteId, env, ctx }) =>
    withRequestStore(store, siteId, async () =>
      (await serveMedia(request, { siteId })) ?? (handle(request, env as never, ctx) as Promise<Response>)),
  demoMedia: { prefix: "demo/", keys: DEMO_KEYS },
});
export const PlaygroundSite = playground.PlaygroundSite;
export default playground.worker;
```

| 装订/ 秘密 | 目的 |
| --- | --- |
| `PLAYGROUND` (可支配对象, `new_sqlite_classes: ["PlaygroundSite"]`(中文(简体) ) | 每个会话都有一个数据库和每日计数器 |
| `ASSETS` (单位:千美元)`run_worker_first: true`(中文(简体) ) | 登陆页( u)`/landing/`), Studio at the root 有SPA倒置,站点资产,演示介质 |
| `PLAYGROUND_SECRET` (≥32个字符) | 签名 `__Host-cloudhal_try` 会话 cookie; 没有它, 只能提供登陆页 |
| `PLAYGROUND_ENABLED` | `"false"` 是杀人开关 |
| `PLAYGROUND_DAILY_SESSIONS` | 协调世界时每天新开庭次数 |
| `SESSION_LIMIT`, (中文(简体) ), `WRITE_LIMIT` (费率限额) | 每个IP新会话, 每个会话写 |
| `TURNSTILE_SECRET`, (中文(简体) ), `TURNSTILE_SITE_KEY` | 只有在会话率限制击中后才要求 |

路线 : `POST /_playground/session` (饼干,那么) `303 /sites`, (中文(简体) ), `POST /_playground/reset`, (中文(简体) ), `/api/*` (警卫员) `isBlockedInPlayground`, (中文(简体) ), `/s/<session>/…` (会议网站, `private, no-store`, (中文(简体) ), `noindex`, (中文(简体) ), `/media/*`测试在 `test/playground-workerd.test.ts`。 。 。 .

## 常见问题

### @cloudhal/cloudflare 是什么？

Cloudflare上的 Cloudhal: 管理员\(API, 认证人, MCP, Studio\) over D1 \+ R2

### 如何安装 @cloudhal/cloudflare？

在项目目录运行 npm install @cloudhal/cloudflare，或使用 pnpm add / yarn add / bun add。

### @cloudhal/cloudflare 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cloudhal/cloudflare 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cloudhal/cloudflare 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=24。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cloudhal/cloudflare 可以商用吗？

@cloudhal/cloudflare 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cloudhal/cloudflare 的下载量有多少？

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

### @cloudhal/cloudflare 还在维护吗？

最新版本 0\.6\.5 发布于 2026/11/09（1 天前）；至今共发布 26 个版本，其中过去 12 个月发布了 26 个；首次发布于 2026/10/20。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。