CLI

TanStarter CLI 是 TanStarter 的自动化部署工具。通过一个引导式命令，它可以从 TanStarter 模板创建新项目、准备 Cloudflare 资源、配置环境变量文件、部署到 Cloudflare Workers，并把初始化后的代码推送到 GitHub。

如果您已经了解 快速开始、Cloudflare 配置 和 部署网站 中的手动流程，那么 CLI 就是更快的方式。它会把这些步骤自动化，帮助您在大约 5 分钟内将 TanStarter 模板部署上线。

它能做什么

CLI 会自动完成原本需要手动处理的 TanStarter 上线流程：

1. 克隆 TanStarter 模板。
2. 使用 pnpm install 安装依赖。
3. 检查本地工具和 Cloudflare 凭据。
4. 创建 Cloudflare D1、R2 和 KV 资源。
5. 更新 wrangler.jsonc 中的 Worker、D1、R2、KV 和路由配置。
6. 写入 .env 和 .env.production。
7. 执行本地和远程的数据库迁移。
8. 构建并部署到 Cloudflare Worker。
9. 同步 Worker 运行时密钥。
10. 创建私有 GitHub 仓库。
11. 同步 GitHub Actions Secrets。
12. 提交代码并推送到 main 分支。

当您想快速获得一个可上线的初始项目，或者需要重复创建多个 TanStarter 项目时，CLI 会非常有用。

前提条件

CLI 开始创建资源前，会检查 node、pnpm、git、gh、GitHub CLI 登录状态和 Cloudflare 凭据。如果缺少 pnpm、git 或 gh，CLI 会尝试通过当前系统可用的包管理器自动安装。

快速部署

可以直接通过 npx 运行 CLI：

npx tanstarter-cli@latest create

TanStarter CLI 会在创建任何资源之前，询问项目名称、GitHub 仓库、Cloudflare 资源名称，以及是否配置自定义域名等信息。流程完成后，您将获得：

• 一个已经部署到 Cloudflare Workers 的网站。
• 一个包含 TanStarter 模板源码的 GitHub 仓库。
• 已连接到项目的 Cloudflare D1、R2 和 KV 资源。
• 已同步运行时环境变量到 Cloudflare Worker。
• 已同步构建时环境变量到 GitHub Actions Secrets，后续可以实现自动化构建部署。

全局安装

如果您会频繁使用 CLI，也可以全局安装：

npm install -g tanstarter-cli

然后运行：

tanstarter create

全局命令支持与 npx 命令相同的参数。

命令参考

tanstarter create [options]
tanstarter create <project-name> --resume
tanstarter delete <project-name> [options]

失败后恢复

如果设置流程在项目目录创建之后失败，您可以先修复错误提示中的问题，然后继续执行：

tanstarter create your-project-name --resume

CLI 会把执行进度保存在 .tanstarter/state.json 中，因此可以从已完成的步骤后继续执行，而不需要从头开始。

删除已创建资源

如果需要删除 CLI 创建的 Cloudflare 和 GitHub 资源，可以运行：

tanstarter delete your-project-name

视频教程

下一步

通过 CLI 完成部署后，可以继续定制模板中的功能：