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, project folders, 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
--nested	false	Applicable for JSON format only. By default, content is pulled in a flat format. Setting this option to true will output the content in a nested structure, where keys are broken into namespaces according to the workspace key convention delimiter.
--status	all	Available statuses: draft/review/final/all.
--has-key	false	Use this flag to pull only content that has been assigned keys. By default, content without keys is assigned auto-generated, non-human-readable IDs.
--tags	''	Pull content 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 any files.
--access-token		Authenticate the pull request using this access token, taking precedence over any other configured access token.
--pages		Filter content by Frontitude pages from your connected projects. Specify a comma-separated page names string to filter content (OR relation). Applicable only when the source is a project.
--screens		Filter content by Frontitude screens from your connected projects. Specify a comma-separated screen names string to filter content (OR relation). Applicable only when the source is a project.

Push

Available from CLI version 1.3.0 and above.

Push new strings from your local source-locale file into the Frontitude copy library. Only new unique keys create new components. Any key that already exists in Frontitude is skipped and left unchanged. No existing content is ever modified.

$ frontitude push

By default, the CLI shows a preview of what would be created and asks for confirmation before writing anything. To skip the prompt, pass --non-interactive or set CI=true in your environment.

To inspect what would be pushed without making any changes:

$ frontitude push --dry-run

Options:

Name	Default	Description
--dry-run	false	Inspect what would be pushed without writing anything. Prints the list of new keys and the count of already-existing keys that would be skipped.
--tag		Comma-separated tag names to apply to newly-created components (e.g. --tag onboarding,checkout). Existing components are not retagged.
--message		Attach a message to this push, visible in the Frontitude activity log. Use @<email> to notify a workspace teammate (e.g. --message "@[email protected] please review").
--non-interactive	false	Skip the dry-run preview and confirmation prompt. Auto-detected when stdin is not a TTY or CI=true is set.
--access-token		Authenticate the push request using this access token, taking precedence over any other configured access token.

Using command aliases

To make it easier to run long commands in web projects, you can use the scripts section in your package.json.

Here’s an example of a command you can add:

"scripts": {
  "pull-copy": "frontitude pull --has-key --tags=Repo1"
}

This allows you to run the following command to fetch content from Frontitude:

npm run pull-copy