Bun

Bun is an all-in-one toolkit for JavaScript and TypeScript apps. It ships as a single executable called bun.

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

Installing

macOS and Linux

Linux users

The unzip package is required to install Bun. Use sudo apt install unzip to install unzip package. Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1. Use uname -r to check Kernel version.

macOS/Linux (curl)

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

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

Homebrew

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

Docker

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

Proto

proto install bun

Windows

Bun requires a minimum of Windows 10 version 1809

Bun provides a limited, experimental native build for Windows. It is recommended to use Bun within Windows Subsystem for Linux and follow the above instructions. To help catch bugs, the experimental build enables many debugging assertions, which will make the binary slower than what the stable version will be.

To install, paste this into a terminal:

PowerShell/cmd.exe

# WARNING: No stability is guaranteed on the experimental Windows builds
powershell -c "irm bun.sh/install.ps1|iex"

Scoop

# WARNING: No stability is guaranteed on the experimental Windows builds
scoop bucket add versions
scoop install bun-canary

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.

How to add your PATH

First, determine what shell you’re using:

echo $SHELL
/bin/zsh # or /bin/bash or /bin/fish

Then add these lines below to bottom of your shell’s configuration file.

~/.zshrc

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

~/.bashrc

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

~/.config/fish/config.fish

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

Save the file. You’ll need to open a new shell/terminal window for the changes to take effect.

Upgrading

Once installed, the binary can upgrade itself.

bun upgrade

Homebrew users — To avoid conflicts with Homebrew, use brew upgrade bun instead.
proto users - Use proto install bun --pin instead.

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.

macOS/Linux (curl)

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

Windows

Remove-Item ~\.bun -Recurse

NPM

npm uninstall -g bun

Homebrew

brew uninstall bun

Proto

proto uninstall bun