Install Biome

Biome is distributed as an npm package and as a standalone executable. Install it with your package manager if your project already has one, or use the standalone executable when you do not use Node.js or when Biome would be the only reason to have a package.json.

Package manager

Install @biomejs/biome as a development dependency:

npm i -D -E @biomejs/biome

pnpm add -D -E @biomejs/biome

bun add -D -E @biomejs/biome

deno add -D npm:@biomejs/biome

yarn add -D -E @biomejs/biome

Once installed, run Biome through your package manager. For example, biome check runs the formatter, the linter, and assist actions on your project:

npx biome check

pnpm biome check

bunx biome check

deno run -A npm:@biomejs/biome check

yarn biome check

Standalone executable

The standalone executable does not need Node.js. Once installed, run it as biome directly.

Supported platforms

Pick the binary that matches your operating system and architecture:

Platform	`arm64`	`x64`
Windows	`win32-arm64`	`win32-x64`
macOS	`darwin-arm64` (Apple silicon)	`darwin-x64`
Linux	`linux-arm64`	`linux-x64`
Linux (musl)	`linux-arm64-musl`	`linux-x64-musl`

Homebrew

Biome is available as a Homebrew formula for macOS and Linux:

1
brew install biome

Winget

Biome is available as a community-maintained package in the Winget repository for Windows:

1
winget install biomejs.biome

Arch Linux

Biome is available as a community-maintained package in the Arch Linux Extra repository:

1
pacman -S biome

The extra repository is enabled by default in /etc/pacman.conf. If it is disabled, uncomment these lines:

1
[extra]
2
Include = /etc/pacman.d/mirrorlist

Docker

Biome publishes official Docker images for the amd64 and arm64 architectures. Tags are available for every major, minor, and patch version:

1
ghcr.io/biomejs/biome:{major}
2
ghcr.io/biomejs/biome:{major}.{minor}
3
ghcr.io/biomejs/biome:{major}.{minor}.{patch}

The image’s working directory is /code. Mount your project there and pass any Biome command:

1
docker run -v $(pwd):/code ghcr.io/biomejs/biome check
2
docker run -v $(pwd):/code ghcr.io/biomejs/biome check --write

GitHub release

Download the binary for your platform from the latest release on GitHub and make it executable:

1
# macOS (Apple silicon)
2
curl -L https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.5.15/biome-darwin-arm64 -o biome
3
chmod +x biome
4

5
# Linux (x64)
6
curl -L https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.5.15/biome-linux-x64 -o biome
7
chmod +x biome
8

9
# Windows (x64, PowerShell)
10
Invoke-WebRequest -Uri "https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.5.15/biome-win32-x64.exe" -OutFile "biome.exe"

Run it as ./biome, or move it to a directory on your PATH to run it as biome.

Upgrade Biome

If you installed Biome with a package manager, install the latest version with the same package manager, keeping the version pinned:

npm i -D -E @biomejs/biome@latest

pnpm add -D -E @biomejs/biome@latest

bun add -D -E @biomejs/biome@latest

deno add -D npm:@biomejs/biome@latest

yarn add -D -E @biomejs/biome@latest

If you installed the standalone executable, run the upgrade command to update to the latest stable version:

1
biome upgrade

Biome detects whether it was installed through Homebrew or as a plain binary and upgrades accordingly. If the detection is wrong, set the BIOME_DISTRIBUTION environment variable.

After a major upgrade, run biome migrate to see the configuration changes the new version requires, then run it with --write to apply them:

npx biome migrate --write

pnpm biome migrate --write

bunx biome migrate --write

deno run -A npm:@biomejs/biome migrate --write

yarn biome migrate --write