Skip to main content
通过 bun init 搭建一个新项目，开始使用 Bun。
terminal
bun init my-app

? 选择一个项目模板 - 按回车键确认。
❯ 空白
  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 是快速启动一个空白 Bun 项目的方法。它会使用合理的默认值猜测配置，且多次运行时不会破坏已有文件。
演示
它会创建：
  • 一个 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 禁用）：
  • 当检测到 Claude CLI 时，会创建一个 CLAUDE.md 文件（可通过环境变量 CLAUDE_CODE_AGENT_RULE_DISABLED 禁用）
  • 当检测到 Cursor 时，会创建一个 .cursor/rules/*.mdc 文件，指导 Cursor AI 使用 Bun 替代 Node.js 和 npm
如果传递 -y 或 --yes，则默认继续而不询问任何问题。 最后，会运行 bun install 来安装 @types/bun。

​
CLI 用法

terminal
bun init <folder?>

​
初始化选项

​
--yes
boolean
接受所有默认提示，无需询问。别名：-y
​
--minimal
boolean
仅初始化类型定义（跳过应用脚手架）。别名：-m

​
项目模板

​
--react
string|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
根据所选项初始化项目文件和配置（例如，创建必要的配置文件和初始目录结构）。具体文件根据模板不同而异。

​
全局配置 & 环境

​
--cwd
string
以不同的工作目录运行 bun init（在脚本中很有用）。

​
帮助

​
--help
boolean
打印此帮助菜单。别名：-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