Awesome

[Deprecated]

This CLI is deprecated and has been replaced by CLI v2

PhraseApp Client (CLI v1)

The PhraseApp Client is available for all major platforms and lets you access all API endpoints as well as easily sync your locale files between your source code and PhraseApp.

Check out our documentation for more information.

If you are looking for out newer CLI v2, please go to https://github.com/phrase/phrase-cli

Quick Start

This quick start will guide you through the basic steps to get up and running with the PhraseApp Client.

1. Install

Download and install the client for your platform. See our detailed installation guide for more information.

Homebrew

If you use homebrew, we have provided a tap to make installation easier on Mac OS X:

    brew tap phrase/brewed
    brew install phraseapp

The tap is linked to our Formula collection and will be updated, when you call brew update as well.

2. Init

Initialize your project by executing the init command. This lets you define your preferred locale file format, source files and more.

$ cd /path/to/project
$ phraseapp init

3. Upload your locale files

Use the push command to upload your locale files from your defined sources:

$ phraseapp push

4. Download your locale files

Use the pull command to download the most recent locale files back into your project according to your targets:

$ phraseapp pull

5. More

To see a list of all available commands, simply execute:

$ phraseapp

To see all supported options for a command, simple use the --help flag:

$ phraseapp locales list --help

See our detailed guides for in-depth instructions on how to use the PhraseApp Client.

Contributing

This tool and it's source code are auto-generated from templates that run against a API specification file. Therefore we can not accept any pull requests in this repository. Please use the GitHub Issue Tracker to report bugs.

Further reading

• PhraseApp Client Download Page

Licenses

phraseapp-client is licensed under MIT license. (see LICENSE)

Parts of phraseapp-client use third party libraries which are vendored and licensed under different licenses: