CLI Overview

What is the Localesy CLI?

The Localesy CLI is a thin, developer-friendly wrapper around the Localesy platform. It lets you keep your translations in sync with your codebase without leaving the terminal - ideal for developers and CI/CD pipelines.

Everything the CLI does ultimately runs through the same Localesy backend that powers the Platform, so the CLI and the web app always share the same source of truth.

Installation

You can run the CLI without installing anything using npx:

npx localesy@latest

Running it with no arguments prints the list of available commands. You can also get help for any command:

localesy --help
localesy sync --help

Tip: localesy <command> --help is always the authoritative reference for the flags a command supports. Each command below has its own page covering the common workflows.

Commands

Command	What it does
`localesy login`	Authenticate with Localesy via your browser.
`localesy logout`	Sign out and remove local credentials.
`localesy init`	Scan your project and create a local config.
`localesy status`	Show what differs between local and remote.
`localesy sync`	Pull remote changes and push local changes.
`localesy translate`	Fill missing translations with AI.
`localesy new`	Create an organization, project or language.
`localesy config`	Inspect your local configuration.
`localesy open`	Open the current project in the web app.

Global options

These options work on (almost) every command:

Option	Description
`--env <name>`	Target a specific Localesy environment.
`--help`	Show help for the command.

Typical workflow

A first-time setup usually looks like this:

localesy login          # authenticate
localesy init           # scan files and create a project
localesy translate      # fill in missing translations
localesy sync           # keep local and remote in sync

From here, continue with Configuration.