Getting Started

Start with one real screen in your existing app. Make the diff understandable and verify the result in a second language.

Saved-plan release status

These guides use CLI 0.14.7 and the extension 0.7.6 workflow. Install or update the CLI before starting. Confirm that polyglot start --help and polyglot wrap --help expose saved plans. In VS Code, use an extension build that includes Localize one screen and run Update CLI if your selected binary is older.

Download the extension below, then open the VS Code Command Palette and run Extensions: Install from VSIX. Select the downloaded file.

Download VS Code extension 0.7.6 SHA-256 checksum

1. Install the CLI

macOS and Linux:

curl -fsSL https://getpolyglot.ai/install.sh | bash

Or with Homebrew:

brew tap polyglot-i18n/tap
brew install polyglot

Your first localized screen

Choose a screen you know well. Review its source, catalog and setup changes, then exercise it in a second language. Local setup and wrapping work without an account.

Requires the CLI build with saved plans and the start command. Check polyglot start --help before following this guide.

Screen source file, relative to your appFirst target languagePaste the plan ID printed by the CLI

Choose one real screen
Run this from the app directory. Polyglot detects its runtime and saves a plan without changing application source. Use polyglot doctor --apps to find apps in a monorepo.
```
polyglot start --file 'src/app/page.tsx' --lang 'de'
```
Review and apply the same plan
Read the full diff and manual-review reasons. Source, catalog, provider and dependency changes belong together. Changed inputs require a fresh plan. Install any reviewed dependency changes before building.
```
polyglot wrap --show PLAN_ID
polyglot wrap --apply PLAN_ID
```
Estimate, then translate this screen
The estimate counts pending keys and languages. Requesting translation sends the selected source strings and context to Polyglot’s hosted translation service. Existing translations may be reused. Sign in when you need hosted project features.
```
polyglot translate --plan PLAN_ID --languages 'de' --estimate
polyglot translate --plan PLAN_ID --languages 'de'
```
Exercise the target-language screen
Open the actual route or native screen, select the language, and use its controls. Check changing labels, placeholders and accessible names. Server startup and a successful build do not establish that the screen works.
```
polyglot preview --lang 'de'
```
Recover only this run
The apply result prints its run ID. Undo restores that run’s files when they still match, preserving unrelated work. A later overlapping edit produces a recovery conflict instead of being overwritten.
```
polyglot runs
# polyglot undo RUN_ID
```

My screen checklist

These are my confirmations, saved only in this browser. Copying a command or translating strings does not verify a working screen.

Enter the reviewed plan ID in the first-screen guide to begin.

I reviewed the complete diff.I applied the plan and kept the patch.I saw the target language and exercised the screen’s controls and accessible labels.I inspected the run’s recovery diff and know how to undo it.On a later change, I completed an incremental run and kept existing translations.

Tomorrow, inspect only new or changed work. Keep existing keys, use your glossary, review translations in the workbench, and pull approved translations through the repository workflow.

polyglot diff
polyglot translate --estimate
polyglot catalogs sync
polyglot pull --approved-only

Next steps

VS Code guide
Saved plans & recovery
CLI Commands — full reference for every command
Glossary — control how specific terms are translated
CI/CD — automate translations in your pipeline

Getting Started

1. Install the CLI

Your first localized screen

Choose one real screen

Review and apply the same plan

Estimate, then translate this screen

Exercise the target-language screen

Recover only this run

Next steps