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 代理规则（使用 $BUN_AGENT_RULE_DISABLED=1 禁用）：
  • 当检测到 Claude CLI 时创建一个 CLAUDE.md 文件（使用 CLAUDE_CODE_AGENT_RULE_DISABLED 环境变量禁用）
  • 一个 .cursor/rules/*.mdc 文件，用于指导 Cursor AI 在检测到 Cursor 时使用 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