Installation

Bun ships as a single executable that can be installed a few different ways.

Installing

macOS and Linux

curl -fsSL https://bun.sh/install | bash # for macOS, Linux, and WSL

# to install a specific version

curl -fsSL https://bun.sh/install | bash -s "bun-v1.0.0"

npm install -g bun # the last `npm` command you'll ever need

brew tap oven-sh/bun # for macOS and Linux

brew install bun

docker pull oven/bun

docker run --rm --init --ulimit memlock=-1:-1 oven/bun

proto install bun

Windows

Bun provides a limited, experimental native build for Windows. At the moment, only the Bun runtime is supported.

• bun <file>
• bun run <file>

The test runner, package manager, and bundler are still under development. The following commands have been disabled.

• bun test
• bun install/add/remove
• bun link/unlink
• bun build

Docker

Bun provides a Docker image that supports both Linux x64 and arm64.

docker pull oven/bun

docker run --rm --init --ulimit memlock=-1:-1 oven/bun

There are also image variants for different operating systems.

docker pull oven/bun:debian

docker pull oven/bun:slim

docker pull oven/bun:alpine

docker pull oven/bun:distroless

Checking installation

To check that Bun was installed successfully, open a new terminal window and run bun --version.

bun --version

1.x.y

To see the precise commit of oven-sh/bun that you're using, run bun --revision.

bun --revision

1.x.y+b7982ac13189

If you've installed Bun but are seeing a command not found error, you may have to manually add the installation directory (~/.bun/bin) to your PATH.

echo $SHELL

/bin/zsh # or /bin/bash or /bin/fish

# add to ~/.zshrc
export BUN_INSTALL="$HOME/.bun"
export PATH="$BUN_INSTALL/bin:$PATH"

# add to ~/.bashrc
export BUN_INSTALL="$HOME/.bun"
export PATH="$BUN_INSTALL/bin:$PATH"

# add to ~/.config/fish/config.fish
export BUN_INSTALL="$HOME/.bun"
export PATH="$BUN_INSTALL/bin:$PATH"

Upgrading

Once installed, the binary can upgrade itself.

bun upgrade

Bun automatically releases an (untested) canary build on every commit to main. To upgrade to the latest canary build:

bun upgrade --canary

View canary build

Uninstall

If you need to remove Bun from your system, use the following commands.

rm -rf ~/.bun # for macOS, Linux, and WSL

npm uninstall -g bun

brew uninstall bun

proto uninstall bun