aboutsummaryrefslogtreecommitdiff
path: root/docs/cli/create.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cli/create.md')
-rw-r--r--docs/cli/create.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/cli/create.md b/docs/cli/create.md
index a6dc90c2c..393378eed 100644
--- a/docs/cli/create.md
+++ b/docs/cli/create.md
@@ -1,3 +1,29 @@
+## `bun init`
+
+Scaffold an empty project with `bun init`. It's an interactive tool.
+
+```bash
+$ bun init
+bun 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.ts
+```
+
+Press `enter` to accept the default answer for each prompt, or pass the `-y` flag to auto-accept the defaults.
+
+## `bun create`
+
Template a new Bun project with `bun create`.
```bash