Bun

Ultra-fast JavaScript runtime, bundler, and package manager. Run scripts, install packages, and build projects at speed.

55 commands

Browse by Topic

Getting Started

Quick setup and installation

4commands

Run

Script execution

8commands

Package

Package management

10commands

Init

Project scaffolding

7commands

Test

Test runner

8commands

Build

Bundler & build

8commands

Tools

bunx & utilities

10commands

Install Bun (macOS/Linux)

$ curl -fsSL https://bun.sh/install | bash

Install Bun using the official installer script

Install Bun (Windows)

$ powershell -c "irm bun.sh/install.ps1 | iex"

Install Bun on Windows using PowerShell

Create new project

$ bun init

Initialize a new Bun project with package.json

Run TypeScript file

$ bun run index.ts

Execute a TypeScript file directly with Bun

Run with Env File

$ bun --env-file=.env.local run script.ts

Load specific env file

Run Script

$ bun run script.ts

Execute a TypeScript/JavaScript file

Hot Reload

$ bun --hot run script.ts

Hot module reloading

List Scripts

$ bun run

Show all available scripts

Run Package Script

$ bun run <script-name>

Run script from package.json

Run in Smol Mode

$ bun --smol run script.ts

Use less memory (for constrained environments)

Watch Mode

$ bun --watch run script.ts

Auto-restart on file changes

Bun Shell

$ bun --shell

Start Bun's cross-platform shell

Add Package

$ bun add <package>

Install and add package to dependencies

Add Dev Dependency

$ bun add -d <package>

Add package to devDependencies

Add Exact Version

$ bun add <package>@1.2.3 --exact

Install specific version without range

Add Global Package

$ bun add -g <package>

Install package globally

Install Dependencies

$ bun install

Install all dependencies from package.json

Clear Cache

$ bun pm cache rm

Clear the package cache

List Packages

$ bun pm ls

List installed packages

Remove Package

$ bun remove <package>

Uninstall a package

Update Packages

$ bun update

Update all dependencies to latest

Update Specific Package

$ bun update <package>

Update a specific package

Create from Template

$ bun create <template> <directory>

Scaffold project from template

Create Elysia App

$ bun create elysia my-api

Create an Elysia API project

Create Hono App

$ bun create hono my-api

Create a Hono API project

Create Next.js App

$ bun create next-app my-app

Create a new Next.js application

Create React App

$ bun create react my-app

Create a new React application

Initialize Project

$ bun init

Create a new Bun project

Init with Defaults

$ bun init -y

Create project with default settings

Run Tests

$ bun test

Run all tests in project

Bail on Failure

$ bun test --bail

Stop on first test failure

Test with Coverage

$ bun test --coverage

Generate code coverage report

Run Specific Test File

$ bun test <file.test.ts>

Run tests in specific file

Filter Tests

$ bun test --filter "test name"

Run tests matching pattern

Rerun Failed Tests

$ bun test --rerun-each 3

Rerun each test multiple times

Set Test Timeout

$ bun test --timeout 10000

Set test timeout in milliseconds

Watch Tests

$ bun test --watch

Re-run tests on file changes

Bundle Code

$ bun build ./src/index.ts --outdir ./dist

Bundle code to output directory

Compile to Binary

$ bun build --compile ./src/index.ts

Create standalone executable

Cross-Compile

$ bun build --compile --target=bun-linux-x64 ./src/index.ts

Compile for different platform

External Dependencies

$ bun build ./src/index.ts --external lodash

Exclude packages from bundle

Build Minified

$ bun build ./src/index.ts --outdir ./dist --minify

Bundle with minification

Build with Sourcemaps

$ bun build ./src/index.ts --outdir ./dist --sourcemap

Generate source maps

Code Splitting

$ bun build ./src/index.ts --outdir ./dist --splitting

Enable code splitting

Build for Target

$ bun build ./src/index.ts --target browser

Build for specific target (browser/node/bun)

Link Package

$ bun link

Use Linked Package

$ bun link <package>

Use a linked package

Show Bin Path

$ bun pm bin

Show local bin folder path

Show Global Bin Path

$ bun pm bin -g

Show global bin folder path

Upgrade Bun

$ bun upgrade

Update Bun to latest version

Upgrade to Canary

$ bun upgrade --canary

Update to latest canary release

Show Version

$ bun --version

Display Bun version

Run Package

$ bunx <package>

Run npm package without installing

Force Bun Runtime

$ bunx --bun <package>

Run package with Bun runtime

Run Create Package

$ bunx create-react-app my-app

Run create-* packages

Discussion

Loading comments...

Bun

Ultra-fast JavaScript runtime, bundler, and package manager. Run scripts, install packages, and build projects at speed.

55 commands

Browse by Topic

Getting Started

Quick setup and installation

4commands

Run

Script execution

8commands

Package

Package management

10commands

Init

Project scaffolding

7commands

Test

Test runner

8commands

Build

Bundler & build

8commands

Tools

bunx & utilities

10commands

Install Bun (macOS/Linux)

$ curl -fsSL https://bun.sh/install | bash

Install Bun using the official installer script

Install Bun (Windows)

$ powershell -c "irm bun.sh/install.ps1 | iex"

Install Bun on Windows using PowerShell

Create new project

$ bun init

Initialize a new Bun project with package.json

Run TypeScript file

$ bun run index.ts

Execute a TypeScript file directly with Bun

Run with Env File

$ bun --env-file=.env.local run script.ts

Load specific env file

Run Script

$ bun run script.ts

Execute a TypeScript/JavaScript file

Hot Reload

$ bun --hot run script.ts

Hot module reloading

List Scripts

$ bun run

Show all available scripts

Run Package Script

$ bun run <script-name>

Run script from package.json

Run in Smol Mode

$ bun --smol run script.ts

Use less memory (for constrained environments)

Watch Mode

$ bun --watch run script.ts

Auto-restart on file changes

Bun Shell

$ bun --shell

Start Bun's cross-platform shell

Add Package

$ bun add <package>

Install and add package to dependencies

Add Dev Dependency

$ bun add -d <package>

Add package to devDependencies

Add Exact Version

$ bun add <package>@1.2.3 --exact

Install specific version without range

Add Global Package

$ bun add -g <package>

Install package globally

Install Dependencies

$ bun install

Install all dependencies from package.json

Clear Cache

$ bun pm cache rm

Clear the package cache

List Packages

$ bun pm ls

List installed packages

Remove Package

$ bun remove <package>

Uninstall a package

Update Packages

$ bun update

Update all dependencies to latest

Update Specific Package

$ bun update <package>

Update a specific package

Create from Template

$ bun create <template> <directory>

Scaffold project from template

Create Elysia App

$ bun create elysia my-api

Create an Elysia API project

Create Hono App

$ bun create hono my-api

Create a Hono API project

Create Next.js App

$ bun create next-app my-app

Create a new Next.js application

Create React App

$ bun create react my-app

Create a new React application

Initialize Project

$ bun init

Create a new Bun project

Init with Defaults

$ bun init -y

Create project with default settings

Run Tests

$ bun test

Run all tests in project

Bail on Failure

$ bun test --bail

Stop on first test failure

Test with Coverage

$ bun test --coverage

Generate code coverage report

Run Specific Test File

$ bun test <file.test.ts>

Run tests in specific file

Filter Tests

$ bun test --filter "test name"

Run tests matching pattern

Rerun Failed Tests

$ bun test --rerun-each 3

Rerun each test multiple times

Set Test Timeout

$ bun test --timeout 10000

Set test timeout in milliseconds

Watch Tests

$ bun test --watch

Re-run tests on file changes

Bundle Code

$ bun build ./src/index.ts --outdir ./dist

Bundle code to output directory

Compile to Binary

$ bun build --compile ./src/index.ts

Create standalone executable

Cross-Compile

$ bun build --compile --target=bun-linux-x64 ./src/index.ts

Compile for different platform

External Dependencies

$ bun build ./src/index.ts --external lodash

Exclude packages from bundle

Build Minified

$ bun build ./src/index.ts --outdir ./dist --minify

Bundle with minification

Build with Sourcemaps

$ bun build ./src/index.ts --outdir ./dist --sourcemap

Generate source maps

Code Splitting

$ bun build ./src/index.ts --outdir ./dist --splitting

Enable code splitting

Build for Target

$ bun build ./src/index.ts --target browser

Build for specific target (browser/node/bun)

Link Package

$ bun link

Use Linked Package

$ bun link <package>

Use a linked package

Show Bin Path

$ bun pm bin

Show local bin folder path

Show Global Bin Path

$ bun pm bin -g

Show global bin folder path

Upgrade Bun

$ bun upgrade

Update Bun to latest version

Upgrade to Canary

$ bun upgrade --canary

Update to latest canary release

Show Version

$ bun --version

Display Bun version

Run Package

$ bunx <package>

Run npm package without installing

Force Bun Runtime

$ bunx --bun <package>

Run package with Bun runtime

Run Create Package

$ bunx create-react-app my-app

Run create-* packages

Discussion

Loading comments...