Files

79 lines
1.6 KiB
Plaintext
Raw Permalink Normal View History

2026-08-27 21:09:14 +00:00
## CLI Usage
```bash terminal icon="terminal"
bun init <folder?>
```
### Initialization Options
<ParamField path="--yes" type="boolean">
{" "}
Accept all default prompts without asking questions. Alias: <code>-y</code>{" "}
</ParamField>
<ParamField path="--minimal" type="boolean">
{" "}
Only initialize type definitions (skip app scaffolding). Alias: <code>-m</code>{" "}
</ParamField>
### Project Templates
<ParamField path="--react" type="string|boolean">
{" "}
Scaffold a React project. When used without a value, creates a baseline React app.
<br /> Accepts values for presets:{" "}
<ul>
{" "}
<li>
<code>tailwind</code> React app preconfigured with Tailwind CSS
</li>{" "}
<li>
<code>shadcn</code> React app with <code>@shadcn/ui</code> and Tailwind CSS
</li>{" "}
</ul>{" "}
Examples:{" "}
<pre>
<code>
bun init --react{"\n"}bun init --react=tailwind{"\n"}bun init --react=shadcn
</code>
</pre>{" "}
</ParamField>
### Output & Files
<ParamField path="(result)" type="info">
{" "}
Initializes project files and configuration for the chosen options. Exact files vary by template.{" "}
</ParamField>
### Help
<ParamField path="--help" type="boolean">
{" "}
Print this help menu. Alias: <code>-h</code>{" "}
</ParamField>
### Examples
- Accept all defaults
```bash terminal icon="terminal"
bun init -y
```
- React
```bash terminal icon="terminal"
bun init --react
```
- React + Tailwind CSS
```bash terminal icon="terminal"
bun init --react=tailwind
```
- React + @shadcn/ui
```bash terminal icon="terminal"
bun init --react=shadcn
```