Skip to main content
使用 bun init 脚手架一个新的 Bun 项目。
terminal
按 enter 接受每个提示的默认答案，或传递 -y 标志以自动接受默认值。
bun init 使用合理的默认值推断设置，并且多次运行时不会产生破坏性。
Demo
它创建：
  • 一个 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_CODE_AGENT_RULE_DISABLED 环境变量禁用），创建一个 CLAUDE.md 文件
  • 当检测到 Cursor 时，创建一个 .cursor/rules/*.mdc 文件，告诉 Cursor AI 使用 Bun 而不是 Node.js 和 npm
传递 -y 或 --yes 以接受默认值而不提示。 最后，它运行 bun install 来安装 @types/bun。

​
CLI 用法

terminal

​
初始化选项

​
--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
为所选选项初始化项目文件和配置。具体文件因模板而异。

​
帮助

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

​
示例

  • 接受所有默认值
    terminal
  • React
    terminal
  • React + Tailwind CSS
    terminal
  • React + @shadcn/ui
    terminal