LinuxCommandLibrary

bun-create

TLDR

Create a new project from an official template interactively

$ bun create [template]
copy

Create a new project from an official template in a new directory
$ bun create [template] [path/to/destination]
copy

Create a new project from a GitHub repository template
$ bun create [https://github.com/username/repo] [path/to/destination]
copy

Create a new project from a local template
$ bun create [path/to/template] [path/to/destination]
copy

Create a new project, overwriting the destination directory if it exists
$ bun create [template] [path/to/destination] --force
copy

Create a new project without initializing a Git repository automatically
$ bun create [template] [path/to/destination] --no-git
copy

Create a new project without installing dependencies automatically
$ bun create [template] [path/to/destination] --no-install
copy

SYNOPSIS

bun create <template> [<path>] [<template-args>...] [options]

PARAMETERS

<template>
    Template name (e.g., react-app, next, vite, astro) from community repo

<path>
    Destination directory (defaults to template name)

<template-args>...
    Arguments passed to the template installer

--bun
    Use Bun as package manager (default)

--npm
    Use npm as package manager

--yarn
    Use Yarn as package manager

--pnpm
    Use pnpm as package manager

--force
    Overwrite existing files without prompting

--dry-run
    Preview actions without executing

--verbose
    Enable verbose logging

--cwd <dir>
    Change working directory

DESCRIPTION

The bun create command is part of Bun, a fast JavaScript/TypeScript runtime, bundler, transpiler, and package manager designed as a drop-in replacement for Node.js, npm, webpack, and Vite.

It enables developers to quickly bootstrap new projects using community-maintained templates for popular frameworks like React, Next.js, SvelteKit, Astro, Remix, Vite, and more. Running bun create <template> <project-name> fetches the latest template from GitHub, generates the project scaffold, installs dependencies with Bun by default, and sets up a ready-to-run environment.

This streamlines development by automating boilerplate setup, ensuring best practices, and supporting TypeScript out-of-the-box. Templates are discoverable via bun create --help or the official Bun documentation. Custom templates can be created and shared. It supports alternative package managers like npm, Yarn, or pnpm via flags, making it versatile for diverse workflows.

CAVEATS

Requires internet for template download; Bun installation mandatory; some templates may need additional setup like database config.

POPULAR TEMPLATES

react-app, next, sveltekit, remix, astro, vite, nuxt, express, hono — full list via bun create.

CUSTOM TEMPLATES

Create/share via GitHub repos with bunx metadata; structure mirrors official ones.

HISTORY

Introduced in Bun v0.5.0 (2022) by Jarred Sumner; evolved with community templates; major updates in v1.0+ for better framework support and package manager flexibility.

SEE ALSO

bun(1), bun init(1), npm(1), yarn(1), pnpm(1)

Copied to clipboard