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.
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
.
How to add to your PATH
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
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.
rm -rf ~/.bun # for macOS, Linux, and WSL
npm uninstall -g bun
brew uninstall bun
proto uninstall bun