命令
所有 CLI 命令的完整参考
概述
Better-T-Stack CLI 提供了多个命令来管理您的 TypeScript 项目。
init (默认命令)
创建一个新的 Better-T-Stack 项目。
create-better-t-stack [project-directory] [options]参数
project-directory(可选): 项目目录的名称或路径
主要选项
--yes, -y: 使用默认配置(跳过提示)--verbose: 以 JSON 格式显示详细结果信息--yolo: 绕过验证和兼容性检查--package-manager <pm>:npm,pnpm,bun--install / --no-install: 创建后安装依赖项--git / --no-git: 初始化 Git 仓库--frontend <types...>: Web 和/或原生框架(参见选项)--backend <framework>:hono,express,fastify,elysia,next,convex,none--runtime <runtime>:bun,node,workers(仅在使用--backend convex或--backend none时可用none)--database <type>:none,sqlite,postgres,mysql,mongodb--orm <type>:none,drizzle,prisma,mongoose--api <type>:none,trpc,orpc--auth <provider>:better-auth,clerk,none(参见选项)--db-setup <setup>:none,turso,d1,neon,supabase,prisma-postgres,mongodb-atlas,docker--examples <types...>:none,todo,ai--web-deploy <setup>:none,wrangler,alchemy--server-deploy <setup>:none,wrangler,alchemy--directory-conflict <strategy>:merge,overwrite,increment,error--render-title / --no-render-title: 显示/隐藏 ASCII 艺术标题--disable-analytics / --no-disable-analytics: 控制分析数据收集
完整参考请参见选项。
示例
# 使用提示进行默认设置
create-better-t-stack
# 使用默认配置快速设置
create-better-t-stack --yes
# 特定配置
create-better-t-stack --database postgres --backend hono --frontend tanstack-routeradd
向现有的 Better-T-Stack 项目添加附加组件或部署配置。
create-better-t-stack add [options]选项
--addons <types...>: 要添加的附加组件(参见附加组件)--web-deploy <setup>: Web 部署设置 (none,wrangler,alchemy)--server-deploy <setup>: 服务器部署设置 (none,wrangler,alchemy)--project-dir <path>: 项目目录(默认为当前目录)--install: 添加后安装依赖项--package-manager <pm>: 要使用的包管理器
示例
# 交互式添加附加组件
create-better-t-stack add
# 添加特定附加组件
create-better-t-stack add --addons pwa tauri --install
# 添加部署设置
create-better-t-stack add --web-deploy wranglersponsors
显示 Better-T-Stack 的赞助商。
create-better-t-stack sponsors显示项目赞助商和支持者列表。
docs
在默认浏览器中打开 Better-T-Stack 文档。
create-better-t-stack docs在浏览器中打开 https://better-t-stack.dev/docs。
builder
在默认浏览器中打开基于 Web 的堆栈构建器。
create-better-t-stack builder打开 https://better-t-stack.dev/new,您可以在其中可视化配置您的堆栈。
全局选项
这些选项适用于任何命令:
--help, -h: 显示帮助信息--version, -V: 显示 CLI 版本
命令示例
创建全栈应用
create-better-t-stack \
--database postgres \
--orm drizzle \
--backend hono \
--frontend tanstack-router \
--auth \
--addons pwa biome创建仅后端项目
create-better-t-stack api-server \
--frontend none \
--backend hono \
--database postgres \
--orm drizzle \
--api trpc向现有项目添加功能
cd my-existing-project
create-better-t-stack add --addons tauri starlight --install编程式使用
对于高级用例、自动化或与其他工具的集成,您可以使用编程式 API 从 Node.js 代码创建项目:
import { init } from "create-better-t-stack";
// 以编程方式创建多个项目
const projects = [
{ name: "api", config: { frontend: ["none"], backend: "hono" } },
{ name: "web", config: { frontend: ["next"], backend: "none" } }
];
for (const { name, config } of projects) {
const result = await init(name, {
yes: true,
...config,
directoryConflict: "increment"
});
console.log(result.success ? `✅ ${name}` : `❌ ${name}: ${result.error}`);
}这对于以下场景很有用:
- 构建工具和生成器 - 从模板创建项目
- CI/CD 流水线 - 自动生成测试项目
- 开发工作流 - 批量创建相关项目
- 自定义工具 - 与现有开发设置集成
完整示例和 API 参考请参见编程式 API 文档。