1. Help Center
  2. Phrase for Developers
  3. Using Phrase from the command line

Get started with Phrase in your terminal

You can use the Phrase Client to easily manage projects and translations from the command line.

We have recently updated our CLI, instead of phraseapp, it is  now called phrase.

Although we try to keep things as similar and compatible as possible, there might be some changes.

All documentation now refers to the phrase CLI.

You can access the previous version of the article here

If you have any questions, please contact us at support@phrase.com.

Besides managing your projects and locale files through the Translation Center, you can also use the Phrase Client to manage your projects and translations from a command-line environment.

The Phrase Client is available for all major platforms. It lets you access all API endpoints, and you can use it to push and pull locale files between your source code and Phrase.

Quick start

Follow these basic steps to get up and running with the Phrase Client.

1. Install the client.
Download and install the client for your platform. For more information, refer to the detailed installation guide.

2. Initialize your project.

Initialize your project by running phrase init. This lets you define your preferred locale file format, source files and more.

$ phrase init

 
3. Upload locale files

Use the push subcommand to upload your locale files.

$ phrase push

 
4. Download locale files

Use the pull subcommand to download the most recent locale files back into your project.

$ phrase pull

 
5.  More subcommands

To see a list of all available subcommands, run phrase by itself, without specifying a subcommand. To see all supported options for a specific subcommand, use the --help flag. For example:

$ phrase locales list --help

You can control how the Phrase Client pushes and pulls files by editing the .phrase.yml configuration file. To learn more about the parameters you can set in this file, refer to the configuration guide.

 

For in-depth instructions on how to set up and use the Phrase Client, refer to these articles:

Installation

Usage

Configuration

Examples

Further reading