93f1d91083
* Update installation.md Adding notes for users that currently use canary version and want to switch back to stable version. * Upadte --------- Co-authored-by: Colin McDonnell <colinmcd94@gmail.com>
3.3 KiB
Bun ships as a single executable that can be installed a few different ways.
macOS and Linux
{% callout %}
Linux users — The unzip package is required to install Bun. Kernel version 5.6 or higher is strongly recommended, but the minimum is 5.1.
{% /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 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
{% /codetabs %}
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 testbun install/add/removebun link/unlinkbun build
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
{% 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
$ npm uninstall -g bun
$ brew uninstall bun
$ proto uninstall bun
{% /codetabs %}