Quick start

Go from a project without Biome to your first biome check in three steps. You need a project with a package.json and a package manager such as npm, pnpm, Yarn, Bun, or Deno.

If you do not use Node.js, or you want to see every installation method, go to the Install Biome page instead.

Install Biome as a development dependency of your project:
- npm
- pnpm
- bun
- deno
- yarn
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
The -E flag pins the exact version in your package.json, so every contributor and your CI run the same version of Biome. See why pinning matters.

Create a configuration file. Biome works without one, but a biome.json lets you share settings with your team and your code editor:

npx biome init

pnpm biome init

bunx biome init

deno run -A npm:@biomejs/biome init

yarn biome init

The generated file enables the formatter, the linter, and assist actions with their recommended settings, and references the JSON Schema so your editor can complete and document every option:

1
{
2
  "$schema": "https://biomejs.dev/schemas/2.5.15/schema.json",
3
  "vcs": {
4
    "enabled": false,
5
    "clientKind": "git",
6
    "useIgnoreFile": false
7
  },
8
  "files": { "ignoreUnknown": false },
9
  "formatter": { "enabled": true, "indentStyle": "tab" },
10
  "linter": {
11
    "enabled": true,
12
    "rules": { "preset": "recommended" }
13
  },
14
  "javascript": { "formatter": { "quoteStyle": "double" } },
15
  "assist": {
16
    "enabled": true,
17
    "actions": { "source": { "organizeImports": "on" } }
18
  }
19
}

Check your project. Run the formatter, the linter, and assist actions in one pass:
- npm
- pnpm
- bun
- deno
- yarn
npx biome check
pnpm biome check
bunx biome check
deno run -A npm:@biomejs/biome check
yarn biome check
Biome lists every file that is not formatted and every diagnostic it found. To apply formatting, safe lint fixes, and assist actions, add --write to the command:
- npm
- pnpm
- bun
- deno
- yarn
npx biome check --write
pnpm biome check --write
bunx biome check --write
deno run -A npm:@biomejs/biome check --write
yarn biome check --write
Any diagnostics that remain either have no fix or have a fix that is unsafe to apply automatically, so they need your attention.

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

Next steps

Set up your editor to see diagnostics as you type and format on save.
Configure Biome to change formatter options, enable or disable rules, and choose which files Biome processes.
Integrate with your VCS to reuse your .gitignore and check only changed files.
Add Biome to your CI pipeline to ensure your code is checked before merging.