Cloudflare 中文文档
Pages
Cloudflare 中文文档
Pages
编辑这个页面
跳转官方原文档
Set theme to dark (⇧+D)
  1. Products
  2. Pages
  3. 开始
  4. C3

C3(create-cloudflare CLI)

C3(create-cloudflare-cli) 是一个命令行工具，旨在帮助你设置新应用程序并将其部署到 Cloudflare。除了速度快之外，它还利用官方开发的 Workers 模板和特定框架的设置指南，确保你设置的每个新应用程序都遵循 Cloudflare 和任何第三方在 Cloudflare 网络上部署的最佳实践。

​​ 创建一个新应用程序

要开始操作，请打开终端窗口并运行

运行 create cloudflare@latest 将提示你安装 create-cloudflare软件包，并引导你完成安装向导。进入设置向导后，系统会询问你想创建哪种类型的应用程序。

应用程序列表包括各种 Workers 模板，以及选择网络框架来创建网站或网络应用程序的选项。

​​ 网络框架

如果选择使用网络框架创建新网站或应用程序，C3 会提示你从以下支持的框架中选择一个：

  • Analog
  • Angular
  • Astro
  • Docusaurus
  • Gatsby
  • Hono
  • Next
  • Nuxt
  • Qwik
  • React
  • Remix
  • Solid
  • Svelte
  • Vue

选择一个框架，系统会提示你安装其创建包，并引导你完成框架的安装向导。

​​ 部署

项目配置完成后，系统会询问你是否要将项目部署到 Cloudflare。这是可选项。

如果选择 not (不)部署，项目将在本地创建，C3 会显示一些有用的链接，以便进一步开发。进入新创建的项目文件夹开始开发。

如果你选择部署，系统会要求你进行身份验证(如果尚未登录)，然后立即部署你的项目。C3 将显示项目的 URL 和一些有用的链接。

​​ CLI 参数

C3 通过一系列交互式提示收集所需的输入。你也可以通过命令行参数指定你的选择，这样就可以跳过这些提示。要在 CI 等非交互式环境中使用 C3，请通过命令行指定所有必要参数。

这是 C3 调用的完整格式和可能的 CLI 参数：

  • DIRECTORY string optional

    • 创建应用程序的目录。应用程序的名称取自目录名称。

  • NESTED ARGS.. string[] optional

    • CLI 参数，用于传递给 C3 可能调用的第三方 CLI(在全栈应用程序中)。

  • --type string optional

    • 应创建的应用程序类型。

    • 该选项的可能值为

      • web-framework: A website or web application.
      • hello-world: A basic “Hello World” Cloudflare Worker.
      • hello-world-durable-object: A Durable Object and a Worker to communicate with it.
      • common: A Cloudflare Worker which implements a common example of routing/proxying functionalities.
      • scheduled: A scheduled Cloudflare Worker (triggered via Cron Triggers).
      • queues: Cloudflare Worker 既是 Queues 的消费者，又是其生产者。
      • chatgptPlugin: A ChatGPT plugin.
      • openapi: 实现 OpenAPI REST 端点的Worker
      • remote-template: 从 git 存储库创建一个新项目。
      • pre-existing: 获取从 Cloudflare 仪表板初始化的 Worker。

  • --framework string optional

    • 创建网络应用时使用的框架类型(使用该选项时，--type 将被忽略)。

    • 该选项的可能值为

      • angular
      • astro
      • docusaurus
      • gatsby
      • hono
      • next
      • nuxt
      • qwik
      • react
      • remix
      • solid
      • svelte
      • vue

  • --template string optional

    • 通过托管在 git 仓库中的外部模板创建新项目

    • 该选项的值可指定为以下任一值：

      • user/repo
      • git@github.com:user/repo
      • https://github.com/user/repo
      • user/repo/some-template (subdirectories)
      • user/repo#canary (branches)
      • user/repo#1234abcd (commit hash)
      • bitbucket:user/repo (BitBucket)
      • gitlab:user/repo (GitLab)

      详情请参见 degit docs 。

      模板至少必须包含以下内容：

      • package.json
      • wrangler.toml
      • src/ containing a worker script referenced from wrangler.toml

      更多示例请参见本软件包的 templates folder。

  • --deploy boolean (default: true) optional

    • 创建应用程序后进行部署。

  • --tsboolean (default: true) optional

    • 在应用程序中使用 TypeScript。

  • --git boolean (default: true) optional

    • 为你的应用程序初始化本地 git 仓库。

  • --open boolean (default: true) optional

    • 用浏览器打开已部署的应用程序(如果未部署应用程序，则忽略此选项)。

  • --existing-script string optional

    • 要克隆到本地的现有 Cloudflare Workers 脚本的名称。使用此选项时，--type 将强制为 pre-existing。

    • 如果指定了 --existing-script，deploy 将被忽略。

  • -y, --accept-defaults boolean optional

    • 使用所有默认的 C3 选项，也可以通过指定来覆盖每个选项。

  • --auto-update boolean (default: true) optional

    • 自动使用最新版本的 C3。

  • -v, --version boolean optional

    • 显示版本号。

  • -h, --help boolean optional

    • 显示帮助信息