LingoSeal CLI

# Add it to your project
npm install --save-dev lingoseal

# Or run it without installing anything
npx lingoseal download

# 1. Initialize a config file in your project root
npx lingoseal init --url https://app.lingoseal.com --project <project-id>

# 2. Put your API token in the environment — never in the config file
export LINGOSEAL_TOKEN=lsk_...

# 3. Download translations (pull)
npx lingoseal download

# 4. Push local translation files to the server
npx lingoseal push --include-base

npx lingoseal init
npx lingoseal init --url https://app.lingoseal.com --project abc-123

# Using the discovered config file
lingoseal download

# Override config values via CLI
lingoseal download \
  --url https://app.lingoseal.com \
  --project abc-123 \
  --token my-secret-token \
  --output ./src/locales \
  --format nested-json

# Download specific languages only
lingoseal download --languages en,de,fr

# Include the base language too
lingoseal download --include-base

# Push all translation files (excluding base language by default)
lingoseal push

# Preview what would change without applying
lingoseal push --dry-run

# Push including the base (source) language
lingoseal push --include-base

# Push specific languages only
lingoseal push --languages de,fr

# Overwrite existing translations on the server
lingoseal push --conflict-strategy overwrite

# Only fill in empty translations
lingoseal push --conflict-strategy overwrite-empty

/** @type {import('lingoseal').LingoSealConfig} */
export default {
  // Required
  url: "https://app.lingoseal.com",
  projectId: "your-project-id",
  token: process.env.LINGOSEAL_TOKEN,

  // Optional
  outputPath: "./src/locales",    // Where to read/write translation files
  format: "flat-json",            // flat-json | nested-json | i18next | csv | qt-ts | android-xml | xcstrings
  filePattern: "{lang}.json",     // Overrides the format's own default
  languages: [],                  // Empty = all project languages
  includeBase: true,              // Include the base (source) language
  namespace: "translation",       // Namespace for i18next format
};

LINGOSEAL_TOKEN     # the API token
LINGOSEAL_URL       # the server URL
LINGOSEAL_PROJECT   # the project id

{
  "home.title": "Welcome",
  "home.description": "This is the homepage",
  "nav.login": "Login"
}

{
  "home": {
    "title": "Welcome",
    "description": "This is the homepage"
  },
  "nav": {
    "login": "Login"
  }
}

{
  "translation": {
    "home.title": "Welcome",
    "home.description": "This is the homepage"
  }
}

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="home_title">Welcome</string>
    <string name="nav_login">Login</string>
</resources>

name: Push source translations

on:
  push:
    branches: [main]
    paths:
      - 'src/locales/en.json'   # adjust to your base language file

jobs:
  push-source:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 22

      - name: Push base language to LingoSeal
        run: >
          npx --yes lingoseal push
          --include-base
          --languages en
          --conflict-strategy overwrite
        env:
          LINGOSEAL_TOKEN: ${{ secrets.LINGOSEAL_TOKEN }}
          LINGOSEAL_URL: ${{ secrets.LINGOSEAL_URL }}
          LINGOSEAL_PROJECT: ${{ secrets.LINGOSEAL_PROJECT }}

name: Pull translations

on:
  schedule:
    - cron: '0 6 * * 1-5'  # Weekdays at 6am UTC
  workflow_dispatch:          # Allow manual trigger

jobs:
  pull-translations:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 22

      - name: Download translations
        run: npx --yes lingoseal download
        env:
          LINGOSEAL_TOKEN: ${{ secrets.LINGOSEAL_TOKEN }}
          LINGOSEAL_URL: ${{ secrets.LINGOSEAL_URL }}
          LINGOSEAL_PROJECT: ${{ secrets.LINGOSEAL_PROJECT }}

      - name: Create PR with updates
        uses: peter-evans/create-pull-request@v6
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          commit-message: 'chore: update translations from LingoSeal'
          title: 'chore: update translations from LingoSeal'
          body: Automated translation update from LingoSeal.
          branch: translations/update
          delete-branch: true

name: Preview translation changes

on:
  pull_request:
    paths:
      - 'src/locales/**'

jobs:
  preview:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Preview changes
        run: >
          npx --yes lingoseal push --dry-run
          --include-base
          --conflict-strategy overwrite
        env:
          LINGOSEAL_TOKEN: ${{ secrets.LINGOSEAL_TOKEN }}
          LINGOSEAL_URL: ${{ secrets.LINGOSEAL_URL }}
          LINGOSEAL_PROJECT: ${{ secrets.LINGOSEAL_PROJECT }}

{
  "scripts": {
    "translations:pull": "lingoseal download",
    "translations:push": "lingoseal push --include-base --conflict-strategy overwrite",
    "translations:preview": "lingoseal push --dry-run --include-base --conflict-strategy overwrite",
    "prebuild": "npm run translations:pull"
  }
}

export default {
  url: "https://app.lingoseal.com",
  projectId: "your-project-id",
  token: process.env.LINGOSEAL_TOKEN,
  outputPath: "./src/locales",
  format: "flat-json",
  filePattern: "{lang}/translation.json",
  includeBase: true,
};

import i18n from 'i18next';
import { initReactI18next } from 'react-i18next';
import en from './locales/en/translation.json';
import de from './locales/de/translation.json';

i18n.use(initReactI18next).init({
  resources: {
    en: { translation: en },
    de: { translation: de },
  },
  lng: 'en',
  fallbackLng: 'en',
});

export default {
  url: "https://app.lingoseal.com",
  projectId: "your-project-id",
  token: process.env.LINGOSEAL_TOKEN,
  outputPath: "./messages",
  format: "nested-json",
  filePattern: "{lang}.json",
  includeBase: true,
};