bun init – Templating

Scaffold an empty Bun project with the interactive bun init command.

bun init

? Select a project template - Press return to submit.
❯ Blank
  React
  Library

✓ Select a project template: Blank

+ .gitignore
+ index.ts
+ tsconfig.json (for editor autocomplete)
+ README.md

To get started, run:

    bun run index.ts

bun install v1.3.0

+ @types/bun@1.3.0
+ typescript@5.9.2

7 packages installed

Press enter to accept the default answer for each prompt, or pass the -y flag to auto-accept the defaults.

How bun init works

CLI Usage

$bun init <folder>

Flags

General

--help

Print this menu

Initialization Options

-y,--yes

Accept all default options

-m,--minimal

Only initialize type definitions

Project Templates

-r,--react

Initialize a React project

--react=tailwind

Initialize a React project with TailwindCSS

--react=shadcn

Initialize a React project with @shadcn/ui and TailwindCSS

Examples

React

The --react flag will scaffold a React project:

bun init --react

The --react flag accepts the following values:

tailwind - Scaffold a React project with Tailwind CSS
shadcn - Scaffold a React project with Shadcn/UI and Tailwind CSS

React + TailwindCSS

This will create a React project with Tailwind CSS configured with Bun's bundler and dev server.

bun init --react=tailwind

React + @shadcn/ui

This will create a React project with shadcn/ui and Tailwind CSS configured with Bun's bundler and dev server.

bun init --react=shadcn