> ## Documentation Index
> Fetch the complete documentation index at: https://bun.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Installation

> Install Bun with npm, Homebrew, Docker, or the official script.

## Overview

Bun ships as a single, dependency-free executable. Install it with the install script, a package manager, or Docker on macOS, Linux, and Windows.

> [!TIP]
>
> After installation, verify with `bun --version` and `bun --revision`.

## Installation

> [tab] macOS & Linux
>
> ```bash curl icon="globe" theme={"theme":{"light":"github-light","dark":"dracula"}}
> curl -fsSL https://bun.com/install | bash
> ```
>
> > [!NOTE]
> >
> > **Linux users:** You need the `unzip` package to install Bun (`sudo apt install unzip`). We recommend kernel version 5.6 or higher. Bun runs on kernels as old as 3.10 (RHEL 7) with graceful degradation of newer syscalls. Use `uname -r` to check your kernel version.

> [tab] Windows
>
> ```powershell PowerShell icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> powershell -c "irm bun.sh/install.ps1|iex"
> ```
>
> > [!WARNING]
> >
> > Bun requires Windows 10 version 1809 or later.
>
> For support and discussion, join the **#windows** channel on the [Discord](https://bun.com/discord).

> [tab] Package Managers
>
> ```bash npm icon="npm" theme={"theme":{"light":"github-light","dark":"dracula"}}
> npm install -g bun # the last `npm` command you'll ever need
> ```
>
> ```bash Homebrew icon="https://mintcdn.com/bun-1dd33a4e/JUhaF6Mf68z_zHyy/icons/homebrew.svg?fit=max&auto=format&n=JUhaF6Mf68z_zHyy&q=85&s=72e2bae1e891694752fa3352050dc96f" theme={"theme":{"light":"github-light","dark":"dracula"}}
> brew install oven-sh/bun/bun
> ```
>
> ```bash Scoop icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> scoop install bun
> ```

> [tab] Docker
>
> Bun provides a Docker image that supports both Linux x64 and arm64.
>
> ```bash Docker icon="docker" theme={"theme":{"light":"github-light","dark":"dracula"}}
> docker pull oven/bun
> docker run --rm --init --ulimit memlock=-1:-1 oven/bun
> ```
>
> ### Image Variants
>
> Bun also publishes image variants for different operating systems:
>
> ```bash Docker icon="docker" theme={"theme":{"light":"github-light","dark":"dracula"}}
> docker pull oven/bun:debian
> docker pull oven/bun:slim
> docker pull oven/bun:distroless
> docker pull oven/bun:alpine
> ```

To check that Bun was installed successfully, open a new terminal window and run:

```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
bun --version
# Output: 1.x.y

# See the precise commit of `oven-sh/bun` that you're using
bun --revision
# Output: 1.x.y+b7982ac13189
```

> [!WARNING]
>
> 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`.

> [accordion] Add Bun to your PATH
>
> > [tab] macOS & Linux
> >
> > **1. Determine which shell you're using**
> >
> > ```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> > echo $SHELL
> > # /bin/zsh  or /bin/bash or /bin/fish
> > ```
> >
> > **2. Open your shell configuration file**
> >
> > * For bash: `~/.bashrc`
> > * For zsh: `~/.zshrc`
> > * For fish: `~/.config/fish/config.fish`
> >
> > **3. Add the Bun directory to PATH**
> >
> > Add these lines to your configuration file:
> >
> > ```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> > export BUN_INSTALL="$HOME/.bun"
> > export PATH="$BUN_INSTALL/bin:$PATH"
> > ```
> >
> > **4. Reload your shell configuration**
> >
> > ```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> > source ~/.bashrc  # or ~/.zshrc
> > ```
>
> > [tab] Windows
> >
> > **1. Determine if the bun binary is properly installed**
> >
> > ```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> > & "$env:USERPROFILE\.bun\bin\bun" --version
> > ```
> >
> > If the command runs successfully but `bun --version` is not recognized, bun is not in your system's PATH. To fix this, open a PowerShell terminal and run the following command:
> >
> > ```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> > [System.Environment]::SetEnvironmentVariable(
> >   "Path",
> >   [System.Environment]::GetEnvironmentVariable("Path", "User") + ";$env:USERPROFILE\.bun\bin",
> >   [System.EnvironmentVariableTarget]::User
> > )
> > ```
> >
> > **2. Restart your terminal**
> >
> > Restart your terminal and test with `bun --version`.
> >
> > ```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> > bun --version
> > ```

***

## Upgrading

Once installed, the binary can upgrade itself:

```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
bun upgrade
```

> [!TIP]
>
> **Homebrew users** \\
>
> To avoid conflicts with Homebrew, use `brew upgrade bun` instead.
>
> **Scoop users** \\
>
> To avoid conflicts with Scoop, use `scoop update bun` instead.

***

## Canary Builds

[-> View canary build](https://github.com/oven-sh/bun/releases/tag/canary)

Bun automatically releases an (untested) canary build on every commit to main. To upgrade to the latest canary build:

```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
# Upgrade to latest canary
bun upgrade --canary

# Switch back to stable
bun upgrade --stable
```

Use a canary build to test new features and bug fixes before they reach a stable release. To help the Bun team fix bugs faster, canary builds automatically upload crash reports.

***

## Installing Older Versions

Since Bun is a single binary, you can install older versions by re-running the installer script with a specific version.

> [tab] Linux & macOS
>
> To install a specific version, pass the git tag to the install script:
>
> ```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> curl -fsSL https://bun.com/install | bash -s "bun-v1.3.3"
> ```

> [tab] Windows
>
> On Windows, pass the version number to the PowerShell install script:
>
> ```powershell PowerShell icon="windows" theme={"theme":{"light":"github-light","dark":"dracula"}}
> iex "& {$(irm https://bun.com/install.ps1)} -Version 1.3.3"
> ```

***

## Direct Downloads

To download Bun binaries directly, visit the [releases page on GitHub](https://github.com/oven-sh/bun/releases).

### Latest Version Downloads

> [card] [Linux x64](https://github.com/oven-sh/bun/releases/latest/download/bun-linux-x64.zip)
>
> Standard Linux x64 binary

> [card] [Linux x64 Baseline](https://github.com/oven-sh/bun/releases/latest/download/bun-linux-x64-baseline.zip)
>
> For older CPUs without AVX2

> [card] [Windows x64](https://github.com/oven-sh/bun/releases/latest/download/bun-windows-x64.zip)
>
> Standard Windows binary

> [card] [Windows x64 Baseline](https://github.com/oven-sh/bun/releases/latest/download/bun-windows-x64-baseline.zip)
>
> For older CPUs without AVX2

> [card] [Windows ARM64](https://github.com/oven-sh/bun/releases/latest/download/bun-windows-aarch64.zip)
>
> Windows on ARM (Snapdragon, etc.)

> [card] [macOS ARM64](https://github.com/oven-sh/bun/releases/latest/download/bun-darwin-aarch64.zip)
>
> Apple Silicon (M1/M2/M3)

> [card] [macOS x64](https://github.com/oven-sh/bun/releases/latest/download/bun-darwin-x64.zip)
>
> Intel Macs

> [card] [Linux ARM64](https://github.com/oven-sh/bun/releases/latest/download/bun-linux-aarch64.zip)
>
> ARM64 Linux systems

### Musl Binaries

For distributions without `glibc` (Alpine Linux, Void Linux):

* [Linux x64 musl](https://github.com/oven-sh/bun/releases/latest/download/bun-linux-x64-musl.zip)
* [Linux x64 musl baseline](https://github.com/oven-sh/bun/releases/latest/download/bun-linux-x64-musl-baseline.zip)
* [Linux ARM64 musl](https://github.com/oven-sh/bun/releases/latest/download/bun-linux-aarch64-musl.zip)

> [!NOTE]
>
> Bun's glibc binaries require glibc 2.17 or newer. If you encounter an error like `bun:
>     /lib/x86_64-linux-gnu/libc.so.6: version GLIBC_... not found`, try using the musl binary. Bun's install script
> automatically chooses the correct binary for your system.

***

## CPU Requirements

CPU requirements depend on which binary you're using:

> [tab] Standard Builds
>
> **x64 binaries** target the Haswell CPU architecture (AVX and AVX2 instructions required)
>
> | Platform | Intel Requirement | AMD Requirement |
> | - | - | - |
> | x64 | Haswell (4th gen Core) or newer | Excavator or newer |

> [tab] Baseline Builds
>
> **x64-baseline binaries** target the Nehalem architecture for older CPUs
>
> | Platform | Intel Requirement | AMD Requirement |
> | - | - | - |
> | x64-baseline | Nehalem (1st gen Core) or newer | Bulldozer or newer |
>
> > [!WARNING]
> >
> > Baseline builds are slower than regular builds. Use them only if you encounter an "Illegal
> > Instruction" error.

> [!NOTE]
>
> Bun does not support CPUs older than the baseline target, which requires the SSE4.2 extension. Bun requires macOS 13.0
> or later.

***

## Uninstall

To remove Bun from your system:

> [tab] macOS & Linux
>
> ```bash terminal icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> rm -rf ~/.bun
> ```

> [tab] Windows
>
> ```powershell PowerShell icon="windows" theme={"theme":{"light":"github-light","dark":"dracula"}}
> powershell -c ~\.bun\uninstall.ps1
> ```

> [tab] Package Managers
>
> ```bash npm icon="npm" theme={"theme":{"light":"github-light","dark":"dracula"}}
> npm uninstall -g bun
> ```
>
> ```bash Homebrew icon="https://mintcdn.com/bun-1dd33a4e/JUhaF6Mf68z_zHyy/icons/homebrew.svg?fit=max&auto=format&n=JUhaF6Mf68z_zHyy&q=85&s=72e2bae1e891694752fa3352050dc96f" theme={"theme":{"light":"github-light","dark":"dracula"}}
> brew uninstall bun
> ```
>
> ```bash Scoop icon="terminal" theme={"theme":{"light":"github-light","dark":"dracula"}}
> scoop uninstall bun
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.