Transifex

  • Documentation
  • CLI Client
  • Introduction to the Client

Introduction to the Client

The Transifex CLI tool, also called “the client,” is a tool for working with source and translation files from the command line interface of various operating systems. Using the client, you’re able to sync files between your repository/local directory and Transifex. You can use the client with a CI tool and automate your localization process to avoid pushing files manually.

The code for the client is Open Source; you can find it here on GitHub.

Requirements

Before you can use the client, you'll first need to:

  • Create a project in the Transifex web app for the content you plan to manage. You cannot create projects through the client.
  • Install the client on your system. The client works with Macs, Linux, and Windows devices. Be sure you’re running a supported version of Python.

Checking for the client

Once the client is installed, the tx command will become available to you. To check whether you already have the Transifex client installed or see which version of the client you have installed, run tx --version.

Authenticating

The client needs a Transifex API token to authenticate. If you don’t have a token yet, you can generate one at https://www.transifex.com/user/settings/api/.

Command list

The client supports the following commands:

Help and troubleshooting

For more information about each command, use tx <command> --help. As an example, to learn more about the tx push command, run tx push --help.

If you're using the Windows executable, use tx.exe instead of tx, e.g. tx.exe push --help.

Additionally, the client supports debug and traceback options for each command to help you troubleshoot issues.

Changelog

To see a list of updates to the client, please refer to the client's Releases page on GitHub.