This guide is meant to help you with migrating to the most up-to-date version of the Phrase CLI
List all commands and help with specific commands
There were some changes to some commands' names and syntax. For an overview of all available commands, you can run
$ phrase help
If you need help with any specific command, you can run
$ phrase [command] --help
$ phrase locales create --help
will result in this output:
Create a new locale.
phrase locales create [flags]
-d, --data string payload in JSON format
-h, --help help for create
--project_id string Project ID
--x_phrase_app_otp string Two-Factor-Authentication token (optional)
-t, --access_token string access token used for authentication
--config string config file (default is ./.phrase.yaml fallback to $HOME/.phrase.yaml)
--host string Host to send Request to
--tfa use Two-Factor Authentication
-u, --username string username used for authentication
-v, --verbose show more messages
Name of the binary and configuration file
The binary is now called phrase. So instead of
you now call
Also, the configuration file is now called .phrase.yml instead of .phraseapp.yml. However, to ensure maximal compatibility, if no .phrase.yml is present, the CLI will look for a .phraseapp.yml.
How parameters are passed
Instead of being tied to providing parameters in a certain order, they are now passed with flags. So instead of
$ phraseapp tag delete <project_id> <name>
you now provide the parameters like this
$ phrase tags delete --project_id <project_id> --name <name>
The parameters can be specified in any order.
Parameter names are now using underscores (_) instead of hyphens (-).
$ phraseapp locale download \
$ phrase locales download \
--project_id <project_id> \
--id <id> \
API docs and Help Articles
You can still find the API reference right here:
Examples for both CLI version 1 and 2 can be found there as well.
Our help guides now refer to CLI version 2, yet we linked the help documentation for the previous version in it, for your consideration.
Download CLI v1 or v2
You can download our CLI client version 2 via https://phrase.com/cli/.
The previous CLI version is still available via GitHub: