Installation | Bun Docs

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

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)

npm

Homebrew

Docker

Proto

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

To install, paste this into a terminal:

PowerShell/cmd.exe

npm

Scoop

PowerShell/cmd.exe
powershell -c "irm bun.sh/install.ps1|iex"

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

Scoop
scoop install bun

For support and discussion, please join the #windows channel on our Discord.

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.

How to add to 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

~/.bashrc

~/.config/fish/config.fish

~/.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.

Scoop users — To avoid conflicts with Scoop, use scoop 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

Note — To switch back to a stable release from canary, run bun upgrade again with no flags.

Uninstall

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

macOS/Linux (curl)

Windows

Scoop

npm

Homebrew

Proto

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

Windows
powershell -c ~\.bun\uninstall.ps1

Scoop
scoop uninstall bun

npm
npm uninstall -g bun

Homebrew
brew uninstall bun

Proto
proto uninstall bun

Installing

macOS and Linux

Windows

Docker

Checking installation

Upgrading

Uninstall