Quickstart

Recommended setup and common workflows.

Install

Install oxfmt as a dev dependency:

npm

$ npm add -D oxfmt

pnpm

$ pnpm add -D oxfmt

yarn

$ yarn add -D oxfmt

bun

$ bun add -D oxfmt

Standalone binary

Oxfmt is also available as a standalone binary. It works as a pure CLI without Node.js, but does not support Prettier-backed formats (these files are skipped), dynamic config files (oxfmt.config.ts), Tailwind CSS class sorting, LSP mode, etc.

The npm package is the recommended way to install Oxfmt and supports all features for now.

Add scripts to package.json:

package.json

{
  "scripts": {
    "fmt": "oxfmt",
    "fmt:check": "oxfmt --check"
  }
}

Format files:

npm

npm run fmt

pnpm

pnpm run fmt

yarn

yarn run fmt

bun

bun run fmt

Check formatting without writing files:

npm

npm run fmt:check

pnpm

pnpm run fmt:check

yarn

yarn run fmt:check

bun

bun run fmt:check

Usage

oxfmt [OPTIONS] [PATH]...

Running oxfmt without arguments formats the current directory (equivalent to prettier --write .).

CLI options like --no-semi are not supported. Use the configuration file instead to ensure consistent settings across CLI and editor integrations.

To use glob patterns in positional paths, be sure to quote them. Otherwise, they may or may not be expanded depending on your environment.

For the complete list of options, see the CLI reference.

Common workflows

Pre-commit with lint-staged

package.json

{
  "lint-staged": {
    "*": "oxfmt --no-error-on-unmatched-pattern"
  }
}

--no-error-on-unmatched-pattern prevents errors when no files match the pattern.

Create a config file

Initialize .oxfmtrc.json with defaults:

oxfmt --init

Migrate from Prettier

oxfmt --migrate prettier

See migrate from prettier for details.

List files that differ

oxfmt --list-different

This is useful for configuring files to ignore.

Piping file contents

echo 'const   x   =   1' | oxfmt --stdin-filepath test.ts

Prints const x = 1;

Node.js API

import { format, type FormatOptions } from "oxfmt";

const input = `let a=42;`;
const options: FormatOptions = {
  semi: false,
};

const { code } = await format("a.js", input, options);
console.log(code); // "let a = 42"

Next steps

• Change configuration
• Setup editors
• Setup CI
• Learn advanced features: sorting, embedded formatting
• Compatibility matrix
• Check CLI reference