mirror of
https://github.com/oven-sh/bun
synced 2026-02-10 02:48:50 +00:00
21 lines
924 B
Markdown
21 lines
924 B
Markdown
`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.
|