Manual installation
You can install Biome to your machine to use like any other command line tool. This can be a great choice if you need to run this manually: for instance, if you use a code editor that does not have a Biome plugin, or if you intend to use this in shell scripts or another local tool to automate processing of source code files, or if you intend to have an AI coding tool execute this tool.
If you are using Biome in a CI/CD pipeline, you should install it directly into the project using a Node.js
package manager (npm, pnpm, etc) and abandon this manual option.
Supported Architectures
Section titled “Supported Architectures”You have to pick the correct binary for your CPU architecture for Biome work. The following table should help you do so.
| CPU Architecture | Windows | macOS | Linux | Linux (musl) |
|---|---|---|---|---|
arm64 | win32-arm64 | darwin-arm64 (M1 or newer) | linux-arm64 | linux-arm64-musl |
x64 | win32-x64 | darwin-x64 | linux-x64 | linux-x64-musl |
Windows
Section titled “Windows”Install Biome either using the winget native package manager for Windows, or a download:
Winget
Section titled “Winget”Native package manager for Windows:
# Windows (x86_64, Powershell)winget install BiomeJS.BiomeDownload
Section titled “Download”Download via Latest CLI release on GitHub or the following shell command:
# Windows (x86_64, Powershell)Invoke-WebRequest -Uri "https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.3.7/biome-win32-x64.exe" -OutFile "%USERPROFILE%Downloadsinariesiome.exe"Now you can use Biome by running C:\users\<your_username>\Downloads\binaries\biome.exe. Note that this does
not register Biome on the PATH var (system or user var), so you cannot call it from within any folder by
simply using biome. In order to register it to the PATH, edit the PATH variable using your operating
system’s GUI or command line:
Either
- Press Windows key + R to open the Run dialog, type sysdm.cpl, and press Enter.
- Add the folder in a new line to the User PATH variable (not system PATH).
or
-
Open Terminal and run:
Terminal window # Windows (x86_64, Powershell)setx PATH "%PATH%;%USERPROFILE%Downloadsinaries"This updates the PATH permanently and applies to future terminal sessions. To update the current terminal, run
Terminal window # Windows (x86_64, Powershell)set PATH="%PATH%;%USERPROFILE%Downloadsinaries"
macOS and Linux
Section titled “macOS and Linux”Biome is available as a Homebrew formula for macOS and Linux users.
brew install biomeUsing a published binary
Section titled “Using a published binary”To install Biome, grab the executable for your platform from the latest CLI release on GitHub and give it execution permission.
# macOS arm64 (Apple Silicon – M1/M2/M3/M4)curl -L https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.3.7/biome-darwin-arm64 -o biomechmod +x biome
# macOS x86_64 (Intel Macs)curl -L https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.3.7/biome-darwin-x64 -o biomechmod +x biome
# Linux x86_64curl -L https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.3.7/biome-linux-x64 -o biomechmod +x biome
# Linux arm64/aarch64 (Raspberry Pi 64-bit, AWS Graviton, etc.)curl -L https://github.com/biomejs/biome/releases/download/@biomejs/biome@2.3.7/biome-linux-arm64 -o biomechmod +x biomeYou can now run Biome with ./biome.
To run it globally from any directory just by typing biome, add it to your PATH.
Here are the recommended ways:
Recommended: Move the binary to a directory already in $PATH
# Most common choice on both macOS and Linuxsudo mv biome /usr/local/bin/biome
# Alternative (user-local, no sudo needed – preferred on many modern Linux distros)mkdir -p ~/.local/binmv biome ~/.local/bin/biomeAlternative: Add the current folder to your PATH
If you prefer not to move the binary, append the current directory to PATH in your shell configuration file.
- macOS (zsh – default since Catalina) – add to
~/.zshrcTerminal window export PATH="$PATH:$(pwd)" - macOS (bash) or Linux – add to
~/.bashrc,~/.zshrc, or equivalentTerminal window export PATH="$PATH:$(pwd)"
Then reload your shell:
source ~/.zshrc # or source ~/.bashrcNow biome works everywhere:
biome --version biome format . biome lint .Docker
Section titled “Docker”Biome publishes official Docker images that support
the amd64 and arm64 architectures for all Biome versions starting from v1.7.0.
ghcr.io/biomejs/biome:{major}ghcr.io/biomejs/biome:{major}.{minor}ghcr.io/biomejs/biome:{major}.{minor}.{patch}Here are a couple examples on how to use the Docker image:
# Lint filesdocker run -v $(pwd):/code ghcr.io/biomejs/biome lintdocker run -v $(pwd):/code ghcr.io/biomejs/biome lint --write
# Format filesdocker run -v $(pwd):/code ghcr.io/biomejs/biome formatdocker run -v $(pwd):/code ghcr.io/biomejs/biome format --writeNext Steps
Section titled “Next Steps”Follow our Getting Started guide.
Copyright (c) 2023-present Biome Developers and Contributors.