Getting Started

Biome is best installed as a development dependency of your projects, but it is also available as a standalone executable that doesn’t require Node.js.

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

Configuration

Although Biome can run with zero configuration, you’ll likely want to tweak some settings to suit your project’s needs, in which case you can run the following command to generate a biome.json configuration file.

npx @biomejs/biome init

pnpm exec biome init

bunx --bun biome init

deno run -A npm:@biomejs/biome init

yarn exec biome init

Usage

Lets get a quick overview of how to use Biome in your project.

Command-line interface

Biome provides a command-line interface to format, lint, and check your code.

# Format all files
npx @biomejs/biome format --write

# Format specific files
npx @biomejs/biome format --write <files>

# Lint files and apply safe fixes to all files
npx @biomejs/biome lint --write

# Lint files and apply safe fixes to specific files
npx @biomejs/biome lint --write <files>

# Format, lint, and organize imports of all files
npx @biomejs/biome check --write

# Format, lint, and organize imports of specific files
npx @biomejs/biome check --write <files>

# Format all files
pnpm exec biome format --write

# Format specific files
pnpm exec biome format --write <files>

# Lint and apply safe fixes to all files
pnpm exec biome lint --write

# Lint files and apply safe fixes to specific files
pnpm exec biome lint --write <files>

# Format, lint, and organize imports of all files
pnpm exec biome check --write

# Format, lint, and organize imports of specific files
pnpm exec biome check --write <files>

# Format all files
bunx biome format --write

# Format specific files
bunx biome format --write <files>

# Lint and apply safe fixes to all files
bunx biome lint --write

# Lint files and apply safe fixes to specific files
bunx biome lint --write <files>

# Format, lint, and organize imports of all files
bunx biome check --write

# Format, lint, and organize imports of specific files
bunx biome check --write <files>

# Format specific files
deno run -A npm:@biomejs/biome format --write <files>

# Format all files
deno run -A npm:@biomejs/biome format --write

# Lint files and apply safe fixes to all files
deno run -A npm:@biomejs/biome lint --write

# Lint files and apply safe fixes to specific files
deno run -A npm:@biomejs/biome lint --write <files>

# Format, lint, and organize imports of all files
deno run -A npm:@biomejs/biome check --write

# Format, lint, and organize imports of specific files
deno run -A npm:@biomejs/biome check --write <files>

# Format all files
yarn exec biome format --write

# Format specific files
yarn exec biome format --write <files>

# Lint files and apply safe fixes to all files
yarn exec biome lint --write

# Lint files and apply safe fixes to specific files
yarn exec biome lint --write <files>

# Format, lint, and organize imports of all files
yarn exec biome check --write <files>

# Format, lint, and organize imports of specific files
yarn exec biome check --write <files>

Editor integrations

Biome is available as a first-party extension in your favorite editors.

There are also community extensions for other editors, such as Vim, Neovim, and Sublime Text, to name a few.

Continuous Integration

Run biome ci as part of your CI pipeline to enforce code quality and consistency across your team. It works just like the biome check command, but is optimized for CI environments.

See the Continuous Integration recipes for more examples.

Next Steps

Success! You’re now ready to use Biome. 🥳

Migrate from ESLint and Prettier
Learn more about how to configure Biome
Learn more about how to use and configure the formatter
Learn more about how to use and configure the linter
Get familiar with the CLI commands and options
Get familiar with the configuration options
Join our community on Discord