Scaffold an empty Bun project with the interactive bun init command.
bun initbun init helps you get started with a minimal project and tries to
guess sensible defaults. Press ^C anytime to quit.
package name (quickstart):
entry point (index.ts):
Done! A package.json file was saved in the current directory.
+ index.ts
+ .gitignore
+ tsconfig.json (for editor auto-complete)
+ README.md
To get started, run:
bun run index.tsPress 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 <entrypoints>
Flags
Help
--help
Print this menu
Defaults
-y,--yes
Accept all default options
Examples
React
The --react flag will scaffold a React project:
bun init --reactThe --react flag accepts the following values:
tailwind- Scaffold a React project with Tailwind CSSshadcn- 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=tailwindReact + @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