## 1. Project Overview & Quickstart (biomejs/biome)

**Biome** is a performant toolchain for web projects, it aims to provide developer tools to maintain the health of said projects.

**Biome is a [fast formatter](https://github.com/biomejs/benchmark#formatting)** for _JavaScript_, _TypeScript_, _JSX_, _JSON_, _CSS_ and _GraphQL_ that scores **[97% compatibility with _Prettier_](https://algora.io/challenges/prettier)**.

**Biome is a [performant linter](https://github.com/biomejs/benchmark#linting)** for _JavaScript_, _TypeScript_, _JSX_, _JSON_, _CSS_, and _GraphQL_ that features **[more than 500 rules](https://biomejs.dev/linter/javascript/rules/)** from ESLint, typescript-eslint, and [other sources](https://github.com/biomejs/biome/discussions/3).
It **outputs detailed and contextualized diagnostics** that help you to improve your code and become a better programmer!

**Biome** is designed from the start to be used [interactively within an editor](https://biomejs.dev/editors/first-party-extensions/).
It can format and lint malformed code as you are writing it.

### Installation

```shell
npm install --save-dev --save-exact @biomejs/biome
```

### Usage

```shell
# format files
npx @biomejs/biome format --write

# lint files and apply the safe fixes
npx @biomejs/biome lint --write

# run format, lint, etc. and apply the safe fixes
npx @biomejs/biome check --write

# check all files against format, lint, etc. in CI environments
npx @biomejs/biome ci
```

If you want to give Biome a run without installing it, use the [online playground](https://biomejs.dev/playground/), compiled to WebAssembly.

## Documentation

Check out our [homepage][biomejs] to learn more about Biome,
or directly head to the [Getting Started guide][getting-started] to start using Biome.

## More about Biome

**Biome** has sane defaults and it doesn't require configuration.

**Biome** aims to support [all main languages][language-support] of modern web development.

**Biome** [doesn't require Node.js](https://biomejs.dev/guides/manual-installation/) to function.

**Biome** has first-class LSP support, with a sophisticated parser that represents the source text in full fidelity and top-notch error recovery.

**Biome** wants to offer a high-quality *Developer Experience*, with descriptive diagnostics and great performance.

**Biome** unifies functionalities that have previously been separate tools. Building upon a shared base allows us to provide a cohesive experience for processing code, displaying errors, parallelize work, caching, and configuration.

Read more about our [project philosophy][biome-philosophy].

**Biome** is [MIT licensed](https://github.com/biomejs/biome/tree/main/LICENSE-MIT) or [Apache 2.0 licensed](https://github.com/biomejs/biome/tree/main/LICENSE-APACHE) and moderated under the [Contributor Covenant Code of Conduct](https://github.com/biomejs/biome/tree/main/CODE_OF_CONDUCT.md).

## Funding

You can fund the project in different ways

### Project sponsorship and funding

You can sponsor or fund the project via [Open collective](https://opencollective.com/biome) or [GitHub sponsors](https://github.com/sponsors/biomejs)

Biome offers a simple sponsorship program that allows companies to get visibility and recognition among various developers.

Biome offers [enterprise support](https://biomejs.dev/enterprise), where Core Contributors can be employed to work on company-focused projects.

## Sponsors

### Platinum Sponsors



|  |
| --- |



### Gold Sponsors



|  |
| --- |



### Silver Sponsors



| [](https://lokalise.com/?utm_source=biome&utm_medium=readme) | [](https://latitude.so/?utm_source=biome&utm_medium=readme) | [](https://www.cloudflare.com/?utm_source=biome&utm_medium=readme) |
| --- | --- | --- |



### Bronze Sponsors



| [](https://vital.io/?utm_source=biome&utm_medium=readme) | [](https://coderabbit.ai/?utm_source=biome&utm_medium=readme) | [](https://forge42.dev/?utm_source=biome&utm_medium=readme) | [](http://rstudio.org/?utm_source=biome&utm_medium=readme) | [](https://pennylane.com/?utm_source=biome&utm_medium=readme) | [](https://jetbrains.com/?utm_source=biome&utm_medium=readme) | [](https://www.egstock.co.jp/?utm_source=biome&utm_medium=readme) | [](https://www.convex.dev/?utm_source=biome&utm_medium=readme) | [](https://graphite.dev/?utm_source=biome&utm_medium=readme) | [](https://kraken.tech/?utm_source=biome&utm_medium=readme) |
| --- | --- | --- | --- | --- | --- | --- | --- | --- | --- |



[biomejs]: https://biomejs.dev/
[biome-philosophy]: https://biomejs.dev/internals/philosophy/
[language-support]: https://biomejs.dev/internals/language-support/
[getting-started]: https://biomejs.dev/guides/getting-started/

## 2. Official Technical Reference & Guides (biomejs/website)

# [`biomejs.dev`](https://biomejs.dev/)

[](https://github.com/biomejs/website/actions/workflows/synchronize.yaml)
[](https://app.netlify.com/sites/biomejs/deploys)

The website source of [biomejs/biome](https://github.com/biomejs/biome).

## Clone

To clone the repository, run

```shell
git clone https://github.com/biomejs/website
```

## Installation

First install pnpm by enabling [corepack](https://nodejs.org/api/corepack.html):

```shell
corepack enable
```

Then install the required dependencies:

```shell
pnpm i --frozen-lockfile
```

## Local Development

This command starts a local development server:

```shell
pnpm dev
```

Most changes are reflected live without having to restart the server.

## Code generation

The pages of the lint rules are all code generated from the repository `biomejs/biome`. To update the pages you have to install the Rust toolchain, because
the code that does that requires reading the source code of the analyzer.

First, make sure that you've pulled the latest version of the repository and installed the required toolchains, then run the corresponding scripts from the **repo root** via `pnpm`:

```shell
# generate only rules files
pnpm codegen:rules

# generate only rules metadata
pnpm codegen:metadata

# generate only release files
pnpm codegen:release-files

# generate all files
pnpm codegen:all
```

## Build

This command generates static content into the `dist` directory:

```shell
pnpm build
```

The `dist` directory can be served using any static contents hosting service, or you can preview the site locally with

```shell
pnpm preview
```