Documentation section

Authorization

Learn how to authorize your request from Localazy CLI including other ways when providing keys in the configuration file is impractical fo security reasons.

To authorize the upload and download operation, you have to provide writeKey and readKey for the particular app. You can obtain keys at https://localazy.com in the Settings of your app on the Access Keys tab.

There are several ways how you can provide the keys for the CLI tool.

Keys in the configuration file 🔗

The simplest and most common way is to provide writeKey and readKey in the configuration file localazy.json:

{

  "writeKey": "your-apps-write-key", 
  "readKey": "your-apps-read-key",

  "upload": {},
  "download": {},
  "transformations": []
  
}

However, it may be impractical to provide the keys in the configuration file for security reasons. For example, if you share your source code on Github or other places. In such a situation, you should consider other ways of authorization described below.

Separate key file 🔗

You can store keys in a separate file called localazy.keys.json. If such a file exists, the keys are loaded from it. You can define a different key file using the command line: localazy [command] -k keys.json

The format of the file with keys is:

{
  "writeKey": "your-apps-write-key", 
  "readKey": "your-apps-read-key"
}

Keys provided on command line 🔗

You can also define both writeKey and readKey directly on the command line:

localazy [command] -r your-read-key -w your-write-key

Priority 🔗

If the keys are provided using more methods, the ones to be used are resolved this way:

1. The keys from the configuration file, if provided, are used only if not provided by other way.

2. The keys from the key file have higher priority than keys from the configuration file.

3. The keys provided on the command line have the highest priority. Note that by using only writeKey or readKey on the command line, you can overwrite only the particular one.