diff options
Diffstat (limited to 'docs/cli/bun-init.md')
| -rw-r--r-- | docs/cli/bun-init.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/cli/bun-init.md b/docs/cli/bun-init.md new file mode 100644 index 000000000..3a0e66815 --- /dev/null +++ b/docs/cli/bun-init.md @@ -0,0 +1,20 @@ +`bun init` is a quick way to start a blank project with Bun. It guesses with sane defaults and is non-destructive when run multiple times. + + + +It creates: + +- a `package.json` file with a name that defaults to the current directory name +- a `tsconfig.json` file or a `jsconfig.json` file, depending if the entry point is a TypeScript file or not +- an entry point which defaults to `index.ts` unless any of `index.{tsx, jsx, js, mts, mjs}` exist or the `package.json` specifies a `module` or `main` field +- a `README.md` file + +If you pass `-y` or `--yes`, it will assume you want to continue without asking questions. + +At the end, it runs `bun install` to install `bun-types`. + +Added in Bun v0.1.7. + +#### How is `bun init` different than `bun create`? + +`bun init` is for blank projects. `bun create` applies templates. |