Install and configure the Smartcat CLI

Overview

The Smartcat CLI is a command-line tool for developers who want to synchronize localization files between a local project and Smartcat. You can import and export files, upload and download source and target files, and run pull and push synchronization steps directly from your terminal.

Binary downloads (latest version)

Download the binary for your platform:

• Linux (x64): https://smartcat-cli.s3.amazonaws.com/smartcat-linux-x64.zip

• Linux (musl, x64): https://smartcat-cli.s3.amazonaws.com/smartcat-linux-musl-x64.zip

• Linux (arm64): https://smartcat-cli.s3.amazonaws.com/smartcat-linux-arm64.zip

• macOS (x64): https://smartcat-cli.s3.amazonaws.com/smartcat-osx-x64.zip

• Windows (x64): https://smartcat-cli.s3.amazonaws.com/smartcat-win-x64.zip

General syntax

The CLI supports the following commands:

The following general options are available:

Configuration

Smartcat CLI reads configuration from the following sources, in order:

1. Global configuration, stored in %APP_DATA%/smartcat/config.json

2. Local configuration, taken from a file called .smartcat (or smartcat.json) in the current directory

3. Environment variables

4. Command-line parameters (see the Global CLI options)

Global CLI options

Main options

• -s|--server — sets the current Smartcat server (optional)

• -w|--workspace — sets the current Smartcat workspace ID (optional)

• -p|--project — sets the current Smartcat project ID (optional)

• -t|--api-token — sets the current Smartcat API token (optional)

Other options

• -g|--global — ignore local configuration and use the global one (optional)

• -c|--config — specifies the path to the config file (optional)