Links

Commands

Initialization

To get started in no time, the init command will walk you through the basic commands to help you set the string sources that you would like to connect to your codebase, and the output file location (existing or a newly created one).
To initialize the CLI, run the next command and follow the instructions:
$ frontitude init

Connect to data source

Connecting string sources (Frontitude projects or the copy library) to your codebase will let you to pull their latest copy into your codebase and stay up to date effortlessly.
To set the sources that you would like to connect to your codebase, run the next command and use the checkbox selection:
$ frontitude source set
To view the list of connected sources:
$ frontitude source list

Pull

After setting the sources that you would like to connect to your codebase, you will be able to pull their latest copy directly to the configured output file, that later can be consumed in your codebase using any i18n framework of your choice (e.g. i18next, react-i18next, etc.), or directly (using require/import).
To pull the latest copy from your connected sources:
$ frontitude pull
Options:
Name
Default
Description
--flat
true (Can’t be changed for now)
The output file will be flat formatted, containing key-value pairs, where each value is a string.
--status
all
Available statuses: draft/review/final/all.
--has-key
false
By default, all the copy is being pulled into the codebase, and copy without a key is set with Frontitude’s auto-generated id (non human-readable). Use this flag to pull only copy that has a key.
--tags
''
Pull copy by tags. Specify comma-separated tag names string to filter copy (AND relation).
--include-metadata
false
Include metadata for each text, such as tags, status, note, mixed style indication, and more.
--include-translations
false
Include latest translations. Each locale is saved to a dedicated file, in the same location as the source file. The locale will be concatenated to the file’s name as part of the extension. E.g. ./strings.es.json
--dry-run
false
Display the results in the CLI without creating or updating the files.
--access-token
Authenticate the pull request using this access token, taking precedence over any other configured access token.