The UI Translator CLI

This tool is the midle man between developer setups and the UI Translator platform.

It's role consist of pushing all the content updates made on the developer's side to the UI Translator so that content professionals can take action on it.

How to use the UIT CLI?

To take action and start managing your content on the UI Translator, follow the steps below:

1. Open an account here on the UI Translator using the web app: https://app.uitranslator.com

2. Install the UI Translator CLI on your development station

3. Setup the UI Translator CLI so it knows where and how to send/get the project content

4. Sync your content with the UI Translator so that content professionals can take care of it using the web app

1. Open an account on the UI Translator

To manage a project on the UI Translator, you will first need to create it. To do that, you need to create an account on the UI Translator using the web app.

Follow the steps below:

• Using your browser, open the UI Translator web app at https://app.uitranslator.com

• Next, create a project
  This will open the project empty state with several source content onboarding options. we will get back to it to setup the CLI

2. Install the UI Translator CLI using npm

Because the UI Translator CLI is a node program, you will need to have npm installed on your computer to proceed

npm install -g @uitranslator/cli 

Verify the installation by issuing the command

uit

You should get the result below.

3. Setup the UI Translator CLI on your project

To let the CLI know which project on the UI Translator to link with and how to do that, you will follow an interractive setup.

• First, move the terminal working directory to your local project root folder.

Example:

cd your_project_folder_path

• Next, start the setup with the command:

uit setup

Fill the required informations(your token and the project ID), you can find this informations on the project empty page created at the step 1, click on the LINK YOUR DEVELOPMENT SETUP button to reveal them.

4. Sync your content

Once your setup done, you will get a prompt from the CLI letting you know that you can sync or watch your content.

• Prefer the watch command to follow up on your content changes if you use the manual method and the sync command if you use the automatic method.
• Issue the chosen command

uit sync

You should see your content appear on the UI Translator dashboard! It's know up to you to add the marketing/product team there so they can do whatever they want with that content.

What next?

Content updated on sync

Every time you run sync your newly added content will be sent to the UIT dashboard and the updates made there will be sent back to you locally so you.

Content test

To test content, let's say they decided to add another locale(Yes, that is totally up to them!) you can test it on the layout by issuing the command

uit test locale_code

Example:

uit test fr

To test the French content

Please keep in mind that you need to do the internationalization on your code, the UI Translator does not touch your code or your framework configuration.

Release the content

When you are about to release that new feature of your software, you can check if the content is ready and approved by the team responsible with it.

If the content is not ready you will get a message stating that.

uit release