Cloudflare AI

本仓库包含与在客户端使用 Cloudflare AI 产品相关的各种软件包和演示应用程序。它是一个由 Nx 和 Changesets 驱动的 monorepo。

软件包

• workers-ai-provider: 一个自定义 provider，它为 Vercel AI SDK 启用 Workers AI 的模型。

本地开发

1. 克隆仓库。

   git clone git@github.com:cloudflare/ai.git
   

2. 安装依赖。

   从根目录运行：

   cd ai
   npm install
   

3. 开发。

   要为特定应用程序启动开发服务器（例如，tool-calling）：

   npx nx dev tool-calling
   

   理想情况下，所有命令都应该从仓库根目录使用 npx nx 前缀执行。这将确保依赖关系图得到正确管理，例如，如果一个软件包依赖于另一个软件包的输出。

4. 测试和 Linting。

• 要为特定项目执行持续集成测试（例如，workers-ai-provider）：

  npx nx test:ci workers-ai-provider
  

• 要 lint 特定项目：

  npx nx lint my-project
  

• 要对一个或多个项目运行更全面的任务扫描（lint、测试、类型检查、构建）：

  npx nx run-many -t lint test:ci type-check build -p "my-project other-project"
  

5. 其他 Nx 任务。

• build: 编译一个项目或一组项目。
• test: 在 watch 模式下运行项目测试。
• test:ci: 在 CI 模式下运行测试（无 watch）。
• test:smoke: 运行冒烟测试。
• type-check: 执行 TypeScript 类型检查。

创建新的演示应用程序

为了 scaffold 一个新的演示应用程序，您可以使用 create-demo 脚本。此脚本将在 demos 目录中创建一个新的演示应用程序。

npm run create-demo <demo-name>

创建应用程序后，将运行 npm install 来安装依赖项，并运行 npx nx cf-typegen <demo-name> 来为演示应用程序生成类型。然后只需使用以下命令启动应用程序：

npx nx dev <demo-name>

贡献

我们感谢贡献并鼓励 pull request。请遵循以下准则：

1. 项目设置：在 fork 或克隆后，使用 npm install 安装依赖项。
2. 分支：为您的功能或修复创建一个新分支。
3. 进行更改：

• 添加或更新相关测试。
• 在推送您的更改时，将运行自动化任务（由 Husky pre-push hook 提供）。

4. Changesets：如果您的更改影响已发布的软件包，请运行 npx changeset 以创建一个 changeset。在 changeset 提示中提供对您的更改的简明摘要。
5. Pull Request：提交一个 pull request 到 main 分支。团队将对其进行审查，如果一切正常，则合并。

发布流程

本仓库使用 Changesets 来管理版本控制和发布：

1. Changeset 创建: 每当进行需要新版本的更改时（例如，错误修复、新功能），运行：

   npx changeset
   

   提供对更改的清晰描述。

2. 合并: 一旦 changeset 被合并到 main 中，我们的 GitHub Actions 工作流程将：

• 检测已更改的软件包，并创建一个 Version Packages PR。
• 自动递增版本（通过 Changesets）。
• 将任何具有版本号的软件包发布到 npm。（演示和其他内部项目不需要版本控制。）

3. 发布: 发布工作流程 (.github/workflows/release.yml) 将在每次推送到 main 时运行。它确保每个发布的软件包都被标记并在 npm 上发布。任何在其 package.json 中具有 version 字段的软件包都将包含在此过程中。

---

如有任何疑问或指导，请打开一个 issue 或提交一个 pull request。我们希望这种结构和流程能帮助您有效地做出贡献。