|
Knowledgebase
EnterprisePlatform
PlatformAPIReact (MCP)CLI
IntegrationsReact (Lingo Compiler)
Alpha
GuidesChangelog

Lingo.dev CLI

  • How it works
  • Setup
  • Quick Start

Configuration

  • Supported Formats
  • i18n.json
  • i18n.lock
  • Supported Locales

Features

  • Existing Translations
  • Adding Languages
  • Overrides
  • Translator Notes
  • Translation Keys
  • Key Renaming
  • Key Locking
  • Key Ignoring
  • Key Preserving
  • Extract Keys with AI

Performance

  • Large Projects
  • Parallel Processing

Retranslation

  • Automatic Retranslation
  • Retranslation
  • Remove Translations

Quick Start

Max PrilutskiyMax Prilutskiy·Updated about 1 month ago·2 min read

Get up and running with the CLI in under 5 minutes.

Prerequisites

Make sure you have Node.js 18.0 or higher installed. Run node --version to check.

Installation#

Install the CLI globally using your preferred package manager:

bash
npm install -g @lingo.dev/cli

Verify Installation#

Confirm the CLI is installed correctly:

bash
lingo --version

You should see output like:

plaintext
@lingo.dev/cli v2.4.0
Node.js v20.10.0

Initialize Your Project#

Navigate to your project directory and run:

bash
cd my-project
lingo init

This interactive command will:

  1. Connect to your account - Authenticate with your API key
  2. Select a project - Choose an existing project or create a new one
  3. Configure locales - Select which languages to support
  4. Set up file structure - Choose where to store translation files

Configuration Created

The CLI creates a lingo.config.json file with your settings. You can modify this file later as needed.

Your First Translation#

Create a simple translation file:

json
{
  "welcome": {
    "title": "Welcome to Lingo.dev",
    "subtitle": "The best translation management platform"
  },
  "auth": {
    "login": "Log in",
    "logout": "Log out"
  }
}

Push Translations#

Upload your translations to the platform:

bash
lingo push

The CLI will:

  • ✅ Analyze your translation files
  • ✅ Validate the structure
  • ✅ Upload to the server
  • ✅ Show a summary of changes
plaintext
✓ Analyzing translation files...
✓ Found 2 locales: en, es
✓ Uploading 15 keys...
✓ Successfully pushed translations

Summary:
  Added: 15 keys
  Updated: 0 keys
  Unchanged: 0 keys

Pull Latest Translations#

Download the latest translations from your team:

bash
lingo pull

Local Changes

If you have local changes, the CLI will warn you before overwriting. Use --force to override.

Watch Mode (Development)#

For active development, enable watch mode:

bash
lingo watch --push --pull

This will:

  • 👀 Watch for local file changes
  • ⬆️ Auto-push changes to the server
  • ⬇️ Auto-pull updates from your team
  • 🔄 Keep everything in sync

Press Ctrl+C to exit watch mode.

Next Steps#

Now that you're set up:

  • Translation file formats

  • Key naming conventions

  • Namespace organization

  • Language codes (ISO 639-1)

  • Regional variants

  • Custom locale configuration

  • Scan source files

  • Generate translation files

  • AI-powered suggestions

  • Validation and linting

  • Type generation

  • Branch management

Getting Help#

Need assistance?

bash
# Show help for all commands
lingo --help

# Show help for a specific command
lingo push --help

Join our Discord community for real-time support!

Was this page helpful?