Skip to content

Latest commit

 

History

History
251 lines (174 loc) · 5.66 KB

installation.md

File metadata and controls

251 lines (174 loc) · 5.66 KB
Raw

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

Installing

macOS and Linux

{% callout %} 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. {% /callout %}

{% codetabs %}

$ 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 install oven-sh/bun/bun # for macOS and Linux

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

$ proto install bun

{% /codetabs %}

Windows

{% callout %} Bun requires a minimum of Windows 10 version 1809 {% /callout %}

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:

{% codetabs %}

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

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

{% /codetabs %}

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.

{% details summary="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.

{% codetabs %}

# 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"

{% /codetabs %} Save the file. You'll need to open a new shell/terminal window for the changes to take effect.

{% /details %}

Upgrading

Once installed, the binary can upgrade itself.

$ bun upgrade

{% callout %} Homebrew users — To avoid conflicts with Homebrew, use brew upgrade bun instead.

proto users - Use proto install bun --pin instead. {% /callout %}

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

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

Uninstall

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

{% codetabs %}

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

powershell -c ~\.bun\uninstall.ps1

$ npm uninstall -g bun

$ brew uninstall bun

$ proto uninstall bun

{% /codetabs %}