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.

1. Install Biome as a development dependency of your project:

   npm

   npm i -D -E @biomejs/biome

   pnpm

   pnpm add -D -E @biomejs/biome

   bun

   bun add -D -E @biomejs/biome

   deno

   deno add -D npm:@biomejs/biome

   yarn

   yarn add -D -E @biomejs/biome

   Version pinning

   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.

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

   npm

   npx biome init

   pnpm

   pnpm biome init

   bun

   bunx biome init

   deno

   deno run -A npm:@biomejs/biome init

   yarn

   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:

   biome.json

   {
     "$schema": "https://biomejs.dev/schemas/2.5.15/schema.json",
     "vcs": {
       "enabled": false,
       "clientKind": "git",
       "useIgnoreFile": false
     },
     "files": { "ignoreUnknown": false },
     "formatter": { "enabled": true, "indentStyle": "tab" },
     "linter": {
       "enabled": true,
       "rules": { "preset": "recommended" }
     },
     "javascript": { "formatter": { "quoteStyle": "double" } },
     "assist": {
       "enabled": true,
       "actions": { "source": { "organizeImports": "on" } }
     }
   }

3. Check your project. Run the formatter, the linter, and assist actions in one pass:

   npm

   npx biome check

   pnpm

   pnpm biome check

   bun

   bunx biome check

   deno

   deno run -A npm:@biomejs/biome check

   yarn

   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

   npx biome check --write

   pnpm

   pnpm biome check --write

   bun

   bunx biome check --write

   deno

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

   yarn

   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.