@verbx/localize-cli

The verbx command-line tool for VerbX Localize. Use it to see what copy your repo contains, translate ahead of a release, and keep the dashboard in step with your code — locally or in CI.

npm install -D @verbx/localize-cli
npx verbx init

Commands

verbx init      # write verbx.config.json
verbx scan      # show what strings it finds — and what it skipped, and why. Sends nothing.
verbx localize  # translate what is missing
verbx pull      # bring published translations down into your repo
verbx push      # send your repo's strings up, so the dashboard reflects your code
verbx publish   # ship reviewed translations as a bundle
verbx sync      # ask the GitHub agent to open a pull request
verbx status    # show your project configuration
verbx doctor    # check config, keys and privacy settings before something fails later

Start with verbx scan — it never sends anything, and it is the cheapest way to find out whether your text is where the scanner expects it.

Configuration

Reads verbx.config.json from the repo root (create it with verbx init):

{
  "projectKey": "proj_…",
  "defaultLocale": "en",
  "locales": ["es", "hi"],
  "privacyMode": "cloud",
  "scan": { "include": ["src/**/*.{ts,tsx,js,jsx}"] }
}

Set the backend host and your credentials from the environment:

export VERBX_LOCALIZE_API="https://…"       # your VerbX backend
export VERBX_API_KEY="vx_…"                 # runtime key — scan, localize, pull
export VERBX_MANAGEMENT_TOKEN="…"           # privileged — push, publish, sync

The two credentials are different on purpose. The vx_ key ships inside your app bundle, so it is translate-only and is rejected by push/publish; the management token writes the catalogue and belongs in CI and on your machine, never in an app.

Docs

Full guide, the SDKs, and the GitHub agent: localize.verbxeco.com — the Docs section is readable without an account.

License

Proprietary. See LICENSE.md and the VerbX terms of service.