bun create

bun create 是可选的——Bun 不需要任何配置即可工作。这个命令存在是为了让上手更快。

使用 bun create 创建新的 Bun 项目。它可以从 React 组件、create-<template> npm 包、GitHub 仓库或本地模板创建项目。要创建空项目，请使用 bun init。

从 React 组件创建

bun create ./MyComponent.tsx 会将已有的 React 组件转变成一个包含热重载和生产构建的一体化开发环境。

bun create ./MyComponent.jsx # 同时支持 .tsx

🚀 Create React App 的继任者 — bun create <component> 提供了开发者们喜爱的 Create React App 体验，但配备了现代工具链、更快的构建速度以及后端支持。

工作原理

当你运行 bun create <component> 时，Bun 会：

使用 Bun 的 JavaScript 打包器分析你的模块图。
收集运行该组件所需的所有依赖。
扫描入口点导出中是否存在 React 组件。
生成包含所需依赖和脚本的 package.json 文件，用来运行该组件。
使用 bun install --only-missing 安装缺失的依赖。
生成以下文件：
- ${component}.html
- ${component}.client.tsx (前端入口点)
- ${component}.css
启动前端开发服务器。

在 Bun 中使用 TailwindCSS

TailwindCSS 是一个用于为 Web 应用程序设置样式的实用优先 CSS 框架。当你运行 bun create <component> 时，Bun 会扫描你的 JSX/TSX 文件以及其导入的所有文件，查找 TailwindCSS 类名。如果检测到 TailwindCSS 类名，它会将以下依赖添加到你的 package.json 中：

package.json

{
  "dependencies": {
    "tailwindcss": "^4",
    "bun-plugin-tailwind": "latest"
  }
}

Bun 还会配置 bunfig.toml，以便通过 Bun.serve() 使用其 TailwindCSS 插件：

bunfig.toml

[serve.static]
plugins = ["bun-plugin-tailwind"]

并在顶部写入包含 @import "tailwindcss"; 的 ${component}.css 文件：

MyComponent.css

@import "tailwindcss";

在 Bun 中使用 `shadcn/ui`

shadcn/ui 是一个用于构建 Web 应用程序的组件库工具。 bun create <component> 会扫描是否有任何从 @/components/ui 导入的 shadcn/ui 组件。如果找到，它会执行：

terminal

# 假设 bun 检测到导入了 @/components/ui/accordion 和 @/components/ui/button
bunx shadcn@canary add accordion button # 以及其他组件

由于 shadcn/ui 本身使用 TailwindCSS，bun create 还会将 TailwindCSS 依赖添加到你的 package.json 中，并配置 bunfig.toml，以便通过 Bun.serve() 使用 Bun 的 TailwindCSS 插件，如前文所述。 bun create 还会设置：

tsconfig.json，将 "@/*" 别名指向 "src/*" 或 .（具体取决于是否存在 src/ 目录）
components.json，以便 shadcn/ui 知道这是一个 shadcn/ui 项目
styles/globals.css 文件，按照 shadcn/ui 的预期配置 Tailwind v4
${component}.build.ts 文件，该文件使用配置了 bun-plugin-tailwind 的方式为生产环境构建组件

使用 bun create ./MyComponent.jsx 可以在本地运行由 Claude 或 ChatGPT 等 LLM 生成的代码。

从 npm 创建

terminal

bun create <template> [<destination>]

如果你没有名称相同的本地模板，此命令会从 npm 下载并运行 create-<template> 包。以下两个命令是等效的：

terminal

bun create remix
bunx create-remix

有关用法说明，请参阅 create-<template> 包的文档。

从 GitHub 创建

bun create <user>/<repo> 会将 GitHub 仓库的内容下载到磁盘。

terminal

bun create <user>/<repo>
bun create github.com/<user>/<repo>

可以选择为目标文件夹指定名称。如果不指定，Bun 将使用仓库名称。

terminal

bun create <user>/<repo> mydir
bun create github.com/<user>/<repo> mydir

然后，Bun 会：

下载模板
将所有模板文件复制到目标文件夹
使用 bun install 安装依赖
初始化一个全新的 Git 仓库。使用 --no-git 标志可选择退出。

默认情况下，Bun 不会覆盖 已有文件。使用 --force 标志可覆盖这些文件。

从本地模板创建

与远程模板不同，使用本地模板运行 bun create 时，如果目标文件夹已经存在，会删除整个目标文件夹。

You can define custom templates on your local file system. Put them in one of the following directories:

$HOME/.bun-create/<name>：全局模板目录
<项目根目录>/.bun-create/<name>：项目专属模板目录

设置 BUN_CREATE_DIR 环境变量可以更改全局模板路径。

To create a local template, create a directory in $HOME/.bun-create named after your template.

cd $HOME/.bun-create
mkdir foo
cd foo

然后，在该目录下创建 package.json 文件，内容如下：

package.json

{
  "name": "foo"
}

在文件系统的其他位置运行 bun create foo，以验证 Bun 是否能找到你的本地模板。

设置逻辑

你可以在本地模板的 package.json 的 "bun-create" 字段中指定安装前后运行的脚本。

package.json

{
  "name": "@bun-examples/simplereact",
  "version": "0.0.1",
  "main": "index.js",
  "dependencies": {
    "react": "^17.0.2",
    "react-dom": "^17.0.2"
  },
  "bun-create": {
    "preinstall": "echo 'Installing...'", // 单条命令
    "postinstall": ["echo 'Done!'"], // 命令数组，会依次执行
    "start": "bun run echo 'Hello world!'"
  }
}

每个字段都接受字符串或字符串数组。数组中的命令会按顺序运行。

字段	描述
`postinstall`	在安装依赖后运行
`preinstall`	在安装依赖前运行

克隆模板后，bun create 会从 package.json 中移除 "bun-create" 部分，然后再将其写入目标文件夹。

参考

CLI 参数

参数	描述
`--force`	覆盖已存在的文件
`--no-install`	跳过安装 `node_modules` 和相关任务
`--no-git`	不初始化 git 仓库
`--open`	运行完成后启动并在浏览器中打开

环境变量

名称	描述
`GITHUB_API_DOMAIN`	Bun 下载内容所使用的 GitHub 域名。如果使用 GitHub Enterprise 或代理，请设置此变量
`GITHUB_TOKEN`（或 `GITHUB_ACCESS_TOKEN`）	允许 `bun create` 访问私有仓库并避免速率限制。如果两者都存在，优先使用 `GITHUB_TOKEN`。

关于 bun create 的工作流程

当你运行 bun create ${template} ${destination} 时，流程如下：如果是远程模板

GET registry.npmjs.org/@bun-examples/${template}/latest 并解析它
GET registry.npmjs.org/@bun-examples/${template}/-/${template}-${latestVersion}.tgz
将 ${template}-${latestVersion}.tgz 解压并提取到 ${destination}
- 如果文件将被覆盖，则发出警告并退出，除非传入了 --force

如果是 GitHub 仓库

从 GitHub API 下载 tarball
解压并提取到 ${destination}
- 如果文件将被覆盖，则发出警告并退出，除非传入了 --force

如果是本地模板

打开本地模板文件夹
递归删除目标目录
使用可用的最快系统调用递归复制文件（在 macOS 上使用 fcopyfile；在 Linux 上使用 copy_file_range）。如果 node_modules 文件夹存在，请勿复制或遍历该文件夹（仅此一项就使其速度快于 cp）
解析 package.json（再次解析！），将 name 更新为 ${basename(destination)}，从 package.json 中移除 bun-create 部分，并将更新后的 package.json 保存到磁盘。
运行 "bun-create": { "preinstall" } 中定义的所有任务
除非传入了 --no-install 或 package.json 中没有依赖项，否则运行 bun install
运行 "bun-create": { "postinstall" } 中定义的所有任务
运行 git init; git add -A .; git commit -am "Initial Commit";
- 将 gitignore 重命名为 .gitignore。npm 会从已发布的软件包中移除 .gitignore 文件。
- 如果存在依赖项，则会在单独的线程中与 node_modules 的安装并发运行
- 已测试在可用时使用 libgit2，其在微基准测试中的速度慢了 3 倍

开始使用

核心运行时

文件与模块系统

HTTP 服务器

网络通信

数据与存储

并发

进程与系统

交互与工具链

实用工具

标准与兼容性

贡献

从 React 组件创建

工作原理

在 Bun 中使用 TailwindCSS

在 Bun 中使用 `shadcn/ui`

从 npm 创建

从 GitHub 创建

从本地模板创建

设置逻辑

参考

CLI 参数

环境变量

​从 React 组件创建

​工作原理

​在 Bun 中使用 TailwindCSS

​在 Bun 中使用 shadcn/ui

​从 npm 创建

​从 GitHub 创建

​从本地模板创建

​设置逻辑

​参考

​CLI 参数

​环境变量

从 React 组件创建

工作原理

在 Bun 中使用 TailwindCSS

在 Bun 中使用 `shadcn/ui`

从 npm 创建

从 GitHub 创建

从本地模板创建

设置逻辑

参考

CLI 参数

环境变量