Your first project in ten minutes
Three things: an account and organization, a project with languages, and the first push from
your code. The wizard in the panel walks through the same steps and shows the real state —
it waits for an event from the CLI, not for a "next" click.
1. Account and organization
- Create an account at
/registerand confirm your e-mail address. - On the first sign-in, create an organization (or pick an existing one if you were invited).
- The first-project wizard starts on its own: name, identifier, source language and target languages.
Languages must exist in the deployment catalogue and be active — that check runs before the project is created, so a failure does not leave an empty project behind.
2. Install the CLI
composer global require babelhub/cli:~0.1.0
babelhub --version
Or per project: composer require --dev babelhub/cli:~0.1.0 and vendor/bin/babelhub.
3. Sign in
babelhub login --api-url=https://your-panel-host
The CLI prints a code and a URL. Open it, approve access and pick the organization. The credential is stored locally.
4. Configure the project
babelhub init
The wizard asks for the project, the source language and the translation file paths, and writes
the answers to .babelhub.json in the project directory. Keep that file in the repository so the
whole team and CI use the same configuration.
5. First push
babelhub push
One request carries the keys, their source texts and what disappeared from the code. After a successful push the wizard lights up "first synchronization" — by itself, without a button.
6. First translation and pull
- In the panel open the project → keys → pick a target language.
- Enter a translation and approve it if you have a reviewer role.
- Fetch the approved catalogs:
babelhub pull
pull writes approved values only and keeps local formatting plus extra keys that BabelHub
does not know about.
What next
- CLI — every command and exit code.
- In the panel: plan and limits (
/plan), organization invitations, project settings.