XLIFF

AI translation for XLIFF files with Lingo.dev CLI

What is XLIFF?

XLIFF (XML Localization Interchange File Format) is an XML-based format for exchanging localization data. It is widely used in the translation industry and supports both version 1.2 and 2.0 specifications.

For example:

<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:2.0"
       version="2.0"
       srcLang="en">

  <file id="messages.properties" original="messages.properties">

    <unit id="welcome_message">
      <segment>
        <source>Hello, world!</source>
      </segment>
    </unit>

    <unit id="button_text">
      <segment>
        <source>Continue</source>
      </segment>
    </unit>

    <unit id="status_message">
      <segment>
        <source>Processing your request...</source>
      </segment>
    </unit>
  </file>
</xliff>

What is Lingo.dev CLI?

Lingo.dev CLI is a free, open-source CLI for translating apps and content with AI. It's designed to replace traditional translation management software while integrating with existing pipelines.

To learn more, see Overview.

About this guide

This guide explains how to translate XLIFF files with Lingo.dev CLI.

You'll learn how to:

  • Create a project from scratch
  • Configure a translation pipeline
  • Generate translations with AI

Prerequisites

To use Lingo.dev CLI, ensure that Node.js v18+ is installed:

❯ node -v
v22.17.0

Step 1. Set up a project

In your project's directory, create an i18n.json file:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

This file defines the behavior of the translation pipeline, including what languages to translate between and where the localizable content exists on the file system.

To learn more about the available properties, see i18n.json.

Step 2. Configure the source locale

The source locale is the original language and region that your content was written in. To configure the source locale, set the locale.source property in the i18n.json file:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

The source locale must be provided as a BCP 47 language tag.

For the complete list of the locale codes that Lingo.dev CLI supports, see Supported locale codes.

Step 3. Configure the target locales

The target locales are the languages and regions you want to translate your content into. To configure the target locales, set the locale.targets property in the i18n.json file:

{
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {}
}

Step 4. Create the source content

If you haven't already, create one or more XLIFF files that contain the content to be translated. These files must be located at a path that includes the source locale somewhere in the path (e.g., as a directory name like en/ or as part of the filename like messages.en.xliff).

Step 5. Create a bucket

  1. In the i18n.json file, add a "xliff" object to the buckets object:

    {
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "xliff": {}
  }
}

  2. In the "xliff" object, define an array of one or more include patterns:

    {
  "$schema": "https://lingo.dev/schema/i18n.json",
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "xliff": {
      "include": ["./[locale]/example.xliff"]
    }
  }
}

    These patterns define which files to translate.

    The patterns themselves:

    • must contain [locale] as a placeholder for the configured locale
    • can point to file paths (e.g., "[locale]/strings.xliff")
    • can use asterisks as wildcard placeholders (e.g., "[locale]/*.xliff")

    Recursive glob patterns (e.g., **/*.xliff) are not supported.

Step 6. Configure an LLM

Lingo.dev CLI uses large language models (LLMs) to translate content with AI. To use one of these models, you need an API key from a supported provider.

To get up and running as quickly as possible, we recommend using Lingo.dev Engine — our own, hosted platform that offers 10,000 tokens of free, monthly usage:

  1. Sign up for a Lingo.dev account.

  2. Run the following command:

    npx lingo.dev@latest login

    This will open your default browser and ask you to authenticte.

  3. Follow the prompts.

Step 7. Generate the translations

In the directory that contains the i18n.json file, run the following command:

npx lingo.dev@latest run

This command:

  1. Reads the i18n.json file.
  2. Finds the files that need to be translated.
  3. Extracts the translatable content from the files.
  4. Uses the configured LLM to translate the extracted content.
  5. Writes the translated content back to the file system.

The first time translations are generated, an i18n.lock file is created. This file keeps track of what content has been translated, preventing unnecessary retranslations on subsequent runs.

Example

en/example-v2.xliff

<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:2.0"
       version="2.0"
       srcLang="en">

  <file id="messages.properties" original="messages.properties">

    <unit id="welcome_message">
      <segment>
        <source>Hello, world!</source>
      </segment>
    </unit>

    <unit id="button_text">
      <segment>
        <source>Continue</source>
      </segment>
    </unit>

    <unit id="save_button">
      <segment>
        <source>Save Changes</source>
      </segment>
    </unit>

    <unit id="status_message">
      <segment>
        <source>Processing your request...</source>
      </segment>
    </unit>
  </file>
</xliff>

es/example-v2.xliff

<?xml version="1.0" encoding="utf-8"?>
<xliff xmlns="urn:oasis:names:tc:xliff:document:2.0"
       version="2.0"
       srcLang="en"
       trgLang="es">

  <file id="messages.properties" original="messages.properties">

    <unit id="welcome_message">
      <segment>
        <source>Hello, world!</source>
        <target>¡Hola, mundo!</target>
      </segment>
    </unit>

    <unit id="button_text">
      <segment>
        <source>Continue</source>
        <target>Continuar</target>
      </segment>
    </unit>

    <unit id="save_button">
      <segment>
        <source>Save Changes</source>
        <target>Guardar Cambios</target>
      </segment>
    </unit>

    <unit id="status_message">
      <segment>
        <source>Processing your request...</source>
        <target>Procesando tu solicitud...</target>
      </segment>
    </unit>
  </file>
</xliff>

i18n.json

{
  "version": "1.10",
  "locale": {
    "source": "en",
    "targets": ["es"]
  },
  "buckets": {
    "xliff": {
      "include": ["./[locale]/example.xliff"]
    }
  },
  "$schema": "https://lingo.dev/schema/i18n.json"
}

i18n.lock

version: 1
checksums:
  33cb76eb379e7352a70c6dace0ea2c20:
    welcome_message: 1308168cca4fa5d8d7a0cf24e55e93fc
    error.validation: b538f828ae3306cbe35e3bd4e0103870
    button_text: ff2b3010cdfa176f8dceeb1898c428c3