Help › Keys, CLI and automation
The command-line tool
On this page
The rl tool is for developers. It runs in a terminal or in a build job and talks to the API with a secret key.
It is not published yet. Today you run it from the repository:
node tools/cli/bin/rl.mjs help. Publishing it, and the name of the package, are OPEN. There is no default server address, so you always say where your control plane is.
Sign in#
Pass your secret key on standard input, never as a command argument:
printf %s "$SECRET" | rl login --api-url https://<your-control-plane> --key-stdin
The key is stored in a credentials file that only you can read. The tool hides any rl_sec_ key in its output.
Common commands#
| Command | What it does |
|---|---|
rl sites create --name Shop --source en --targets fr,de | Create a site |
rl push strings.json --site <id> | Send strings. --dry-run works without a network |
rl translate --wait | Run machine translation and wait |
rl publish --wait | Publish and wait |
rl pull --base <origin> --public-key <key> --site-key <key> | Download and verify the published files. Needs no secret key |
rl pull --translations --lang fr | Save one language as a file |
rl export --format xliff --out backup.xlf | Export all translations |
rl import fr.xlf --lang fr --dry-run | Import a file; --dry-run shows what would change |
Other commands: whoami, logout, scan, jobs, usage, glossary and keys. Use --json for machine-readable output.
Exit codes#
0 worked, 1 error, 2 wrong usage, 3 sign-in problem, 4 a job you waited for failed or ran out of time.
Safety#
The tool sends your key only to the address you configured, over a secure connection. It does not follow redirects. A file named .resilientlang.json that contains a key is refused.
For the framework kits, rl pull is how you get the bundle to build against. See Install on Next.js.