// getting-started

Installation

The ConvertAtlas API lets you run any converter or formatter programmatically. Install the CLI with npm, or call the REST endpoints directly — no key needed for the free tier.

terminal copy
$ npm install -g convertatlas
$ convertatlas --version
convertatlas v1.4.0 (linux-x64)
The CLI requires Node 18+. Everything also works straight from convertatlas.org with no install.

Quick start

Convert a file from the terminal, or pipe data straight through. The CLI mirrors every tool you find on convertatlas.org.

terminal copy
$ echo '{"a":1}' | convertatlas json --pretty
✓ formatted 2 lines (3ms)

Configuration

All options live in a single atlas.config.js. Every key is optional — defaults match the website behavior exactly.

atlas.config.js copy
export default {
  target: 'es2022',
  minify: true,
  regions: ['fra', 'iad', 'sin']
}
Changing target invalidates the build cache — the first rebuild after will be slower.