BabelizeBabelize
CLI

Installation & Setup

Install the Babelize CLI (@babelize/cli), log in, verify the connection to your account, configure defaults, and log out. Step-by-step setup with examples.

Install

You don't have to install anything: in your project's folder, run

npx babelize

babelize on npm is a short name for @babelize/cli, pinned to an exact CLI release, so npx @babelize/cli runs the same thing. Node.js 22 or later is required.

To have the babelize command available everywhere, install it globally:

npm install -g @babelize/cli
# or
yarn global add @babelize/cli

Login

npx babelize signs you in when it needs to. To sign in on its own:

babelize auth login

The first time, it asks whether you're connecting to Babelize Cloud or a self-hosted server. Then pick GitHub or Google, and your browser opens to sign in (the CLI receives the session on a temporary localhost port), or pick email and enter your email and password. Credentials are written to the CLI config directory for your platform:

PlatformPath
Linux~/.config/@babelize/cli-nodejs/config.json
macOS~/Library/Preferences/@babelize/cli-nodejs/config.json
Windows%APPDATA%\@babelize\cli-nodejs\Config\config.json

The file is plain JSON restricted to your user (mode 600 on macOS/Linux).

Login with flags (non-interactive)

babelize auth login --email you@example.com --password yourpassword
babelize auth login --github     # or --google: skip the menu, sign in in the browser

For CI pipelines, use a Babelize API key as BABELIZE_TOKEN instead — see CI/CD.

Connect to a different API URL

babelize auth login --api-url https://babelize.example.com/api   # a self-hosted backend

Verify the connection

# Check who you're logged in as
babelize auth whoami

# Check API health
babelize status

# Deep health check (verifies DB, Redis, queues)
babelize status --deep

Configuration

LocationContents
~/.config/@babelize/cli-nodejs/config.json (Linux)Access token, refresh token, and saved API URL
.babelize/config.json in your projectSource and target languages remembered by npx babelize, and the cloud project ID from babelize init

See the Login section above for the macOS and Windows paths.

You can override the API URL for one command with --api-url, set it with the BABELIZE_API_URL environment variable, or save one with babelize auth login --api-url <url> (localhost URLs included). The flag wins over the variable, and the variable over the saved URL:

BABELIZE_API_URL=http://localhost:3001/api babelize projects list

Logout

babelize auth logout

This revokes your session on the server and clears local credentials.

Last updated: 2026-11-01

How is this guide?

On this page