Skip to content

Latest commit

 

History

History
219 lines (150 loc) · 8.41 KB

README.md

File metadata and controls

219 lines (150 loc) · 8.41 KB
Raw

Lokalise CLI v2

Getting started

Lokalise CLI v2 allows you to manipulate any object or data in your Lokalise workspace, which includes files, projects, keys, translations, comments, contributors, teams and more.

Whats new in v2?

This version of CLI tool has been completely rebuilt from scratch and is not compatible with the v1 CLI command syntax. Instead of being just an upload/download tool this release supports all Lokalise API v2 endpoints.

Installation

Get the binaries for your platform, unarchive and put into any executable folder. All set!

MacOS

Install using Homebrew:

brew tap lokalise/cli-2
brew install lokalise2

Direct download:

Linux

Get the binaries (including for Raspberry Pi) using our installer script:

curl -sfL https://raw.githubusercontent.com/lokalise/lokalise-cli-2-go/master/install.sh | sh

Direct download:

FreeBSD

Windows

Install using scoop:

scoop bucket add extras
scoop install lokalise2

Direct download:

Docker

Docker image could be downloaded from the following registries:

Tokens

All endpoints require the --token parameter. You can generate your API token in Personal profile. Note, the token is personal and mimics your access level on team and project level. If you require a user-independent API token, create a separate user in your team (e.g. API user), set proper access rights and use this user's token.

Passing the flags

Boolean

All boolean flags must be passed via the = sign, i.e. --original-filenames=false.

Strings

Flags of type strings should be comma-delimited, i.e. --include-tags=one,two.

JSON objects

Some flags require a JSON-encoded object passed as string, i.e. --languages='[{"lang_iso":"en","custom_iso":"en-us"},{"lang_iso":"en_GB","custom_iso":"en-gb"}]'. There is an online tool to help you with the escaping.

Usage

Run lokalise2 --help from the terminal to see the list of commands and subcommands. Run lokalise2 command subcommand --help to see the help page.

Commands

Examples

Download files from Lokalise

lokalise2 \
    --token <token> \
    --project-id <project_id> \
    file download \
    --format json \
    --unzip-to ./locales

Upload a file to Lokalise

lokalise2 \
    --token <token> \
    --project-id <project_id> \
    file upload \
    --file /tmp/en.json \
    --lang-iso en

Branches

If you are using project branching feature in Lokalise, simply add branch name separated by semicolon to the project ID in any command to access the branch, i.e. 3002780358964f9bab5a92.87762498:feature/new-release.

Config file

Optionally, you may rename included config-example.yml to config.yml and set various CLI tool parameters like token or timeouts. You can specify a config file location using --config parameter.

Rate limits

Access to all endpoints is limited to 6 requests per second from 14 September, 2021. This limit is applied per API token and per IP address. If you exceed the limit, a 429 HTTP status code will be returned and the corresponding exception will be raised that you should handle properly. To handle such errors, we recommend an exponential backoff mechanism with a limited number of retries.

Only one concurrent request per token is allowed.

Changes

2.6.8 (Oct 21, 2021)

  • Updated Lokalise GO SDK to v3.2.0

2.6.7 (Jul 27, 2021)

  • Added binaries for Apple M1
  • Fixed release automation configuration
  • Upgraded Go to v1.16

2.6.6 (Jul 12, 2021)

  • Fixed --key-name parameter being optional for key update
  • Updated documentation link to supported file formats

2.6.5 (Jul 12, 2021)

  • Added note for file download --disable-references flag

2.6.4 (Mar 15, 2021)

  • Fixed file upload poll for project branch

2.6.3 (Dec 21, 2020)

  • Added --branch flag for webhook create and update actions

2.6.2 (Nov 23, 2020)

  • Added --use-automations flag to file upload, create keys and bulk update

2.6.1 (October 28, 2020)

  • Fixed file path detection for file upload action

2.6.0 (August 5, 2020)

  • Added BSD-Clause-3 license

2.5.2 (July 28, 2020)

  • Added --skip-detect-lang-iso flag for file upload action

2.5.1 (May 28, 2020)

  • Fix flag naming typo for file upload
    • Changed --pool to --poll
    • Changed --pool-timeout to --poll

2.5.0 (May 28, 2020)

  • Added queued process commands
  • Changed file upload to use queued processing
    • Added --pool flag to obtain the upload result
    • Added --pool-timeout flag to configure the upload pooling maximum duration
    • Changed --convert-placeholders default value to true

2.3.1 (April 30, 2020)

Added --custom-translation-status-ids flag for file upload action, along with --custom-translation-status-inserted-keys, --custom-translation-status-skipped-keys and --custom-translation-status-updated-keys flags

2.3.0 (February 26, 2020)

Added --hidden-from-contributors flag for file upload action

2.2.3 (February 7, 2020)

Added better description for boolean flags

2.2.2 (January 27, 2020)

Changed upper case in archive names. Removed README.md from binary archives

2.2.1 (January 17, 2020)

Fixes:

  • --project-id hasn't been processed correctly

2.2.0 (January 16, 2020)

Added possibility to specify a configuration file with a --config flag

2.1.0 (November 25, 2019)

Updated go-lokalise-api library version, bug fixes, switched binary building to goreleaser

2.03 (October 22, 2019)

Endpoint parameter fixes.

2.00 (October 15, 2019)

Initial release.