執行環境套件管理器打包器測試執行器程式碼檢查格式化指南參考部落格意見回饋

bun init

使用互動式命令 bun init 搭建一個空的 Bun 專案骨架

使用 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