CLI Reference

Command Line Interface

The IntlPull CLI is the fastest way to manage translations in your development workflow. Sync, scan, and push translations without leaving your terminal.

Installation

npm install -g @intlpull/cli

Or use npx to run without installing: npx intlpull <command>

Configuration

Run npx intlpull init to create a config file. The CLI will prompt for your project settings.

The config file (intlpull.config.js) looks like this:

module.exports = {
  projectId: 'proj_abc123',
  sourceLanguage: 'en',
  outputDir: './messages',
  format: 'json',
  namespaces: ['common', 'auth', 'settings']
}

Commands

init

Initialize IntlPull in your project. Creates config file and links to your project.

Usage:

npx intlpull init

Options:

  • --project <id>Specify project ID
  • --format <type>Output format (json, yaml, ts)

sync

Download translations from IntlPull to your local project.

Usage:

npx intlpull sync

Options:

  • --lang <code>Only sync specific language
  • --namespace <name>Only sync specific namespace
  • --watchWatch for changes and sync automatically

push

Upload local translations to IntlPull.

Usage:

npx intlpull push

Options:

  • --file <path>Push specific file
  • --overwriteOverwrite existing translations

scan

Find hardcoded strings in your codebase.

Usage:

npx intlpull scan

Options:

  • --applyTransform strings to i18n function calls
  • --dry-runShow what would change without modifying
  • --pattern <glob>Files to scan (default: src/**/*.{tsx,jsx})

watch

Watch for translation changes and sync in real-time.

Usage:

npx intlpull watch

Options:

  • --poll <ms>Polling interval (default: 3000)

migrate

Import from other translation platforms.

Usage:

npx intlpull migrate --from lokalise

Options:

  • --from <platform>Source: lokalise, crowdin, phrase, transifex
  • --api-key <key>API key for source platform

status

Show translation status and missing keys.

Usage:

npx intlpull status

Options:

  • --lang <code>Check specific language

Common Workflows

Daily Development

Start watch mode to sync changes in real-time while you develop:

npx intlpull watch

Find Missing Translations

Scan your code for hardcoded strings that need to be translated:

npx intlpull scan --dry-run

CI/CD Integration

Pull translations in your build pipeline:

npx intlpull sync && npm run build

Environment Variables

VariableDescription
INTLPULL_API_KEYYour API key (recommended for CI)
INTLPULL_PROJECT_IDOverride project ID from config
INTLPULL_OUTPUT_DIROverride output directory