@cloudhal/cloudflare

中文文档
0.6.5发布于 2026/11/09Apache-2.0TypeScriptES Module构建来源已验证近 30 天下载 4053

Cloudhal on Cloudflare: the admin Worker (API, auth, MCP, Studio) over D1 + R2

原始使用文档

@cloudhal/cloudflare

The Cloudhal admin Worker (ADR-0012): Studio (static assets), the HTTP API, Better Auth on D1, the MCP endpoint and the push/pull endpoints on one origin, over the deployment's D1 database and R2 bucket. After every publish/rollback it purges the site Worker's edge cache through the SITE service binding.

// 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 });
Binding / secretPurpose
DB (D1), BLOBS (R2)the site graph, snapshots, auth, audit
ASSETSbuilt Studio (not_found_handling: single-page-application, run_worker_first for /api/*, /mcp, /.well-known/*)
SITE (service)the site Worker, for cache purges
BETTER_AUTH_SECRET, MCP_STATE_KEYsessions; signed approval state
CLOUDHAL_PREVIEW_SECRET, CLOUDHAL_PURGE_TOKENshared with the site Worker
CLOUDHAL_DEPLOY_TOKENcloudhal push / pull
CLOUDHAL_SIGNUPfirst-user (default — only the first account, the owner, can sign up), closed or open

The site Worker itself is the project's Astro build (@cloudhal/astro-renderer/cloudflare-entry). Both are deployed, configured and tested by @cloudhal/cli (cloudhal deploy, test/cloudflare*.test.ts on workerd).

Playground Worker (RFC-0036)

@cloudhal/cloudflare/playground runs a public playground: every visitor gets a disposable Cloudhal in their own SQLite-backed Durable Object (PlaygroundSite), seeded on first use and deleted an hour after the last request (two hours at most), or at once on Reset.

// 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;
Binding / secretPurpose
PLAYGROUND (Durable Object, new_sqlite_classes: ["PlaygroundSite"])one database per session, and the daily counter
ASSETS (run_worker_first: true)landing page (/landing/), Studio at the root with SPA fallback, site assets, demo media
PLAYGROUND_SECRET (≥ 32 chars)signs the __Host-cloudhal_try session cookie; without it only the landing page is served
PLAYGROUND_ENABLED"false" is the kill switch
PLAYGROUND_DAILY_SESSIONSnew sessions per UTC day
SESSION_LIMIT, WRITE_LIMIT (rate limits)new sessions per IP, writes per session
TURNSTILE_SECRET, TURNSTILE_SITE_KEYasked for only after a session-rate-limit hit

Routes: POST /_playground/session (cookie, then 303 /sites), POST /_playground/reset, /api/* (guarded by isBlockedInPlayground), /s/<session>/… (the session's site, private, no-store, noindex), /media/*. Tested on workerd in test/playground-workerd.test.ts.

版本与发布记录

@cloudhal/cloudflare 共发布 26 个版本,首次发布于 2026/10/20;过去 12 个月发布了 26 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.6.5latest2026/11/091 天前
0.6.42026/11/081 天前
0.6.32026/11/081 天前
0.6.22026/10/2614 天前
0.6.12026/10/2417 天前
0.6.02026/10/2317 天前

关于 @cloudhal/cloudflare 的常见问题

@cloudhal/cloudflare 是什么?

Cloudhal on Cloudflare: the admin Worker (API, auth, 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 和提交记录判断。