Skip to main content
Get from zero to your first translation sync in under 5 minutes.

​
Prerequisites

  • An Entri account (sign up at app.nt3.io)
  • Node.js 18 or later
  • A project with at least one target language configured in the Entri dashboard

​
Step 1: Install the CLI

Install the nt3 CLI globally: 
npm install -g nt3
Or use it without installing via npx: 
npx nt3 <command>

​
Step 2: Create an API token

  1. Open the Entri dashboard and go to Settings > API Tokens
  2. Click Create token
  3. Give the token a name (e.g., “Local development”) and click Create
  4. Copy the token — it starts with entri_ and is only shown once

​
Step 3: Log in

nt3 login
Paste your API token when prompted. The token is stored in ~/.nt3/config.json with owner-only file permissions. For non-interactive environments, pass the token directly: 
nt3 login -t entri_your_token_here

​
Step 4: Initialize your project

Run this in your project root (where your translation files live): 
nt3 init
The CLI will prompt you for:
  • Your Project ID (found in the Entri dashboard under Settings)
  • Your source language (e.g., en)
  • The file pattern path (e.g., src/locales/{lang}.json)
  • The file format (e.g., json-nested)
This creates a .nt3.yml configuration file: 
project_id: "proj_abc123"
source_language: en
file_patterns:
  - path: "src/locales/{lang}.json"
    format: json-nested

​
Step 5: Push your source strings

Upload your source translation file to Entri: 
nt3 push
Entri imports the file and creates translation keys for every string it finds.

​
Step 6: Translate with AI (optional)

Trigger AI translation for all target languages: 
nt3 translate --all
Entri uses your project’s configured AI settings (provider, tone, style) and skips keys that already have translations.

​
Step 7: Pull translations

Download the translated files back to your project: 
nt3 pull
Files are written to the paths defined in your .nt3.yml, replacing {lang} with each target language code.

​
What’s next

CLI Configuration

Learn all the options available in .nt3.yml, including multi-pattern setups.

CI/CD Integration

Automate translation syncing in GitHub Actions and other pipelines.

API Tokens

Create scoped tokens for different environments and team members.

REST API

Integrate Entri directly into your application using the REST API.