bun init · 文档

使用 bun init 搭建一个新的 Bun 项目。

terminal

bun init my-app

Text

? 选择一个项目模板 - 按回车键确认。
❯ 空白
  React
  库

✓ 选择的项目模板：空白

 + .gitignore
 + CLAUDE.md
 + .cursor/rules/use-bun-instead-of-node-vite-npm-pnpm.mdc -> CLAUDE.md
 + index.ts
 + tsconfig.json（用于编辑器自动补全）
 + README.md

按 enter 接受每个提示的默认答案，或者传递 -y 标志以自动接受默认值。

bun init 会根据合理的默认值推断设置，并且重复运行时不会破坏现有内容。

它会创建：

一个 package.json 文件，其名称默认为当前目录名
一个 tsconfig.json 或 jsconfig.json 文件，具体取决于入口文件是否为 TypeScript 文件
一个入口文件，默认为 index.ts，除非存在 index.{tsx, jsx, js, mts, mjs} 中的任意一个文件，或者 package.json 指定了 module 或 main 字段
一个 README.md 文件

AI Agent 规则（可通过设置环境变量 $BUN_AGENT_RULE_DISABLED=1 禁用）：

当 bun init 检测到 Claude CLI 时创建一个 CLAUDE.md 文件（可通过 CLAUDE_CODE_AGENT_RULE_DISABLED 环境变量禁用）
当 bun init 检测到 Cursor 时创建一个 .cursor/rules/*.mdc 文件（可通过 CURSOR_AGENT_RULE_DISABLED 环境变量禁用）；该文件会告诉 Cursor AI 使用 Bun，而不是 Node.js 和 npm

传递 -y 或 --yes，即可在不显示提示的情况下接受默认值。

最后，会运行 bun install 来安装 @types/bun。

CLI 用法

terminal

bun init <folder?>

初始化选项

--yesboolean

接受所有默认提示，无需询问。别名：-y

--minimalboolean

仅初始化类型定义（跳过应用脚手架）。别名：-m

项目模板

--reactstring|boolean

搭建一个 React 项目。无值时，创建一个基础的 React 应用。
支持以下预设值：

tailwind —— 预配置了 Tailwind CSS 的 React 应用
shadcn —— 含有 @shadcn/ui 和 Tailwind CSS 的 React 应用

示例：

bun init --react
bun init --react=tailwind
bun init --react=shadcn

输出与文件

(result)info

根据所选选项初始化项目文件和配置。具体文件因模板而异。

帮助

--helpboolean

打印此帮助菜单。别名：-h

示例

接受所有默认值
terminal
```
bun init -y
```
React
terminal
```
bun init --react
```
React + Tailwind CSS
terminal
```
bun init --react=tailwind
```
React + @shadcn/ui
terminal
```
bun init --react=shadcn
```