Cloudinary CLI reference

The Cloudinary CLI (Command Line Interface) enables you to interact with Cloudinary through the command line. For example, you can perform Admin and Upload API operations by typing commands into a terminal without having to spend time setting up a formal coding environment. Additional helper commands are provided to help you to try out transformations, optimizations, and other common actions with minimal effort. You can also combine CLI commands in a batch file to automate laborious tasks.

On this page:

• Installation and configuration
  • Setting configuration parameters
  • Upgrade
• Basic commands
  • Tutorial contents
• Command overview
  • CLI options
  • Commands
• Command reference
  • admin
  • uploader
  • search
  • provisioning
  • migrate
  • clone
  • sync
  • upload_dir
  • regen_derived
  • utils
  • make
  • url
  • config

Rate this page:

Installation and configuration

1. Prerequisite: To use the Cloudinary CLI, you need Python 3.6 or later. You can install Python from https://www.python.org. The Python Package Installer (pip) is installed with it.

2. To install the Cloudinary CLI, run:

   pip3 install cloudinary-cli

3. To make all your cld commands point to your Cloudinary product environment, set up your CLOUDINARY_URL environment variable, which takes the form <API_KEY>:<API_SECRET>@<CLOUD_NAME>.

   For example, to set a temporary environment variable:

   • On Mac or Linux:
     export CLOUDINARY_URL=cloudinary://123456789012345:abcdefghijklmnopqrstuvwxyzA@cloud_name

   • On Windows:
     set CLOUDINARY_URL=cloudinary://123456789012345:abcdefghijklmnopqrstuvwxyzA@cloud_name

   You may prefer to set up a persistent environment variable, but be aware that you could put your API secret at risk by storing it in your shell's startup script.
   Tip

   Copy the API environment variable format from the API Keys page of the Cloudinary Console Settings. Replace <your_api_key> and <your_api_secret> with your actual values. Your cloud name is already correctly included in the format.

4. Check your configuration by running:

   cld config

   A response of the following form is returned:

   cloud_name:     <CLOUD_NAME>
   api_key:        <API_KEY>
   api_secret:     ***************<LAST_4_DIGITS>
   private_cdn:    <True|False>
   signature_algorithm:    <sha1|sha256>

Setting configuration parameters

You can set any of the configuration parameters by appending them to your CLOUDINARY_URL environment variable as a query string, either when setting up your default configuration or when setting up alternative configurations using the config command.

For example, to use the Cloudinary data center at https://api-eu.cloudinary.com and set your custom domain name to domain_name.com, add the upload_prefix and cname parameters to the environment variable:

export CLOUDINARY_URL='cloudinary://123456789012345:abcdefghijklmnopqrstuvwxyzA@cloud_name?upload_prefix=https://api-eu.cloudinary.com&cname=domain_name.com'

You can see which configuration parameters are set by running the cld config command:

cloud_name:     cloud_name
api_key:        123456789012345
api_secret:     ***************xyzA
private_cdn:    False
signature_algorithm:    sha1
upload_prefix:  https://api-eu.cloudinary.com
cname:          domain_name.com

Upgrade

To upgrade your installation of the Cloudinary CLI to the latest version, enter:

pip3 install --upgrade cloudinary-cli

Basic commands

To help you get started, there are some basic commands you can use.

For a list of commands, enter:

cld --help

To see the version of CLI, underlying Python SDK and Python, enter:

cld --version

To see the available Admin API methods, enter:

cld admin

To see the available upload API methods, enter:

cld uploader

To show the usage for the search API, enter:

cld search --help

To see the available utility methods, enter:

cld utils

See the Command overview for a listing of all available commands, or the Command reference for syntax details and usage examples of the commands.

Take a look at this video to see the CLI being installed and configured, plus some basic commands in action:

Video Player is loading.

Play Video

Play

Unmute

Current Time 0:00

/

Duration 0:00

Loaded: 0%

Stream Type LIVE

Seek to live, currently behind liveLIVE

Remaining Time -0:00

 

1x

Playback Rate

• 2x
• 1.5x
• 1.25x
• 1x, selected
• 0.5x

Descriptions

• descriptions off, selected

Captions

• captions off, selected

Audio Track

Fullscreen

This is a modal window.

Tutorial contents

Command overview

All Cloudinary CLI commands start with cld. The general syntax for the commands is as follows:

For example, the following command runs the resources_by_moderation method in the Admin API, limiting information output to the ERROR level. It returns details of up to 40 raw files that have been rejected by the Perception Point Malware Detection anti-malware plugin, saving the output in a file called 'output.txt'.

cld -v ERROR admin --save output.txt -o max_results 40 -o resource_type raw resources_by_moderation perception_point rejected

This command can be broken down as follows:

Optional parameters can either be specified as command options (as in the above example) or using a syntax that assigns values.

• If specified as command options they can be positioned either before or, more intuitively, after the method.
• If specified using the assign syntax they must be specified after the method and any required parameters.

The example above can therefore also be entered as:

cld -v ERROR admin --save output.txt resources_by_moderation perception_point rejected -o max_results 40 -o resource_type raw

or (using the syntax that assigns values):

cld -v ERROR admin --save output.txt resources_by_moderation perception_point rejected max_results=40 resource_type=raw

CLI options

Commands

API commands

File Management

Helpers

Configuration

Command reference

admin

The admin command enables you to run any methods that can be called through the Admin API. The Admin API is a rate-limited API that provides full control of all uploaded media assets (resources), fetched social profile pictures, generated transformations and more.

See the Admin API reference for details about each of the methods.

Syntax

Command options

Methods

Use cld admin to list all of the available Admin API methods. Then refer to the Admin API reference to see the parameters applicable to each method.

For example, the method resources_by_tag has a required parameter tag, and various optional parameters. To list up to ten videos (using the optional parameters max_results and resource_type) tagged with "animals", enter:

cld admin resources_by_tag animals -o max_results 10 -o resource_type video

cld resources_by_tag animals -o max_results 10 -o resource_type video

Examples

Show all the tags in your product environment.

cld admin tags

List all the resource types in a product environment:

cld admin resource_types

Create a named transformation, then use the named transformation in an upload preset.

cld admin create_transformation circle_face "c_thumb,w_250,h_250,g_face,r_max,q_auto"

cld admin create_upload_preset name=circle_face_on_upload transformation=circle_face

uploader

The uploader command enables you to run any methods that can be called through the upload API. The upload API enables you to upload and manage media assets in your Cloudinary product environment.

See the Upload API reference for details about each of the methods.

Syntax

Command options

Methods

Use cld uploader to list all of the available upload API methods. Then refer to the Upload API reference to see the parameters applicable to each method.

For example, the method rename has two required parameters, from_public_id and to_public_id, and various optional parameters. To rename photo1 to photo2, making photo2 private and invalidating photo1 on the CDN (using the optional parameters to_type and invalidate), enter:

cld uploader rename photo1 photo2 -o to_type private -o invalidate true

cld rename photo1 photo2 -o to_type private -o invalidate true

Examples

Imagine that you have a bunch of photos that you want to turn into a slide show. You can tag them on upload and then create an animated GIF from the images. In the following example, we have a local folder containing images of birds. The bash script below runs from within that folder and uploads each JPG in the local folder to a folder in Cloudinary called "birds", adding the tags "bird", "feathers" and "beak". It then uses the multi method to create an animated GIF from all images with the "bird" tag, applying a delay of 1300 ms between each frame.

#!/bin/bash

for image in *.jpg
do
   cld uploader upload "$image" folder="birds" tags="bird,feathers,beak"   
done

cld uploader multi bird delay=1300

The result is a slide show of the bird images:

Here's another example of the multi method in action:

Video Player is loading.

Play Video

Play

Unmute

Current Time 0:00

/

Duration 0:00

Loaded: 0%

Stream Type LIVE

Seek to live, currently behind liveLIVE

Remaining Time -0:00

 

1x

Playback Rate

• 2x
• 1.5x
• 1.25x
• 1x, selected
• 0.5x

Descriptions

• descriptions off, selected

Captions

• captions off, selected

Audio Track

Fullscreen

This is a modal window.

Tutorial contents

And here are some more upload API methods being used to generate an image sprite from pages of a PDF:

Video Player is loading.

Play Video

Play

Unmute

Current Time 0:00

/

Duration 0:00

Loaded: 0%

Stream Type LIVE

Seek to live, currently behind liveLIVE

Remaining Time -0:00

 

1x

Playback Rate

• 2x
• 1.5x
• 1.25x
• 1x, selected
• 0.5x

Descriptions

• descriptions off, selected

Captions

• captions off, selected

Audio Track

Fullscreen

This is a modal window.

Tutorial contents

search

The search command runs the Admin API search method. This method allows you to filter and retrieve information on all the assets in your product environment with the help of query expressions in a Lucene-like query language.

See the search method documentation for more details.

Syntax

Command options

expression

The search expression. For supported expressions, see Expressions.

Examples

Find images tagged with "bird", that have been uploaded within the last day, and are larger than 100 kB in size. In the response, include the tags field, sort the results by public_id in ascending order, and limit the returned results to 30 resources:

cld search -f tags -n 30 -s public_id asc "resource_type:image AND tags=bird AND uploaded_at>1d AND bytes>100k"

Sample output:

{
  "total_count": 4,
  "time": 110,
  "resources": [
    {
      "public_id": "birds/ndnqgfjucvqt0aagrv0d",
      "display_name": "eagle",
      "asset_folder": "birds",
      "filename": "ndnqgfjucvqt0aagrv0d",
      "format": "jpg",
      "version": 1572953308,
      "resource_type": "image",
      "type": "upload",
      "created_at": "2019-11-05T11:28:28+00:00",
      "uploaded_at": "2019-11-05T11:28:28+00:00",
      "bytes": 233593,
      "backup_bytes": 0,
      "width": 1920,
      "height": 1265,
      "aspect_ratio": 1.51779,
      "pixels": 2428800,
      "tags": [
        "bird",
        "feathers",
        "beak"
      ],
      "url": "http://res.cloudinary.com/cloud_name/image/upload/v1572953308/birds/ndnqgfjucvqt0aagrv0d.jpg",
      "secure_url": "https://res.cloudinary.com/cloud_name/image/upload/v1572953308/birds/ndnqgfjucvqt0aagrv0d.jpg",
      "status": "active",
      "access_mode": "public",
      "access_control": null,
      "etag": "c03d613e7e96c317d1db3dab0544ce07"
    },
    {
      "public_id": "birds/pa6o8xvvbg22dceytes0",
      "display_name": "hawk",
      "asset_folder": "birds",
      "filename": "pa6o8xvvbg22dceytes0",
      "format": "jpg",
      "version": 1572953306,
      "resource_type": "image",
      "type": "upload",
      "created_at": "2019-11-05T11:28:26+00:00",
      "uploaded_at": "2019-11-05T11:28:26+00:00",
      "bytes": 420735,
      "backup_bytes": 0,
      "width": 1920,
      "height": 1277,
      "aspect_ratio": 1.50352,
      "pixels": 2451840,
      "tags": [
        "bird",
        "feathers",
        "beak"
      ],
      "url": "http://res.cloudinary.com/cloud_name/image/upload/v1572953306/birds/pa6o8xvvbg22dceytes0.jpg",
      "secure_url": "https://res.cloudinary.com/cloud_name/image/upload/v1572953306/birds/pa6o8xvvbg22dceytes0.jpg",
      "status": "active",
      "access_mode": "public",
      "access_control": null,
      "etag": "c6acb28c097000ddc4674965d2ee30d3"
    },
    {
      "public_id": "birds/rjgx7odwsqj8v6r3hxpr",
      "display_name": "robin",
      "asset_folder": "birds",
      "filename": "rjgx7odwsqj8v6r3hxpr",
      "format": "jpg",
      "version": 1572953304,
      "resource_type": "image",
      "type": "upload",
      "created_at": "2019-11-05T11:28:24+00:00",
      "uploaded_at": "2019-11-05T11:28:24+00:00",
      "bytes": 420892,
      "backup_bytes": 0,
      "width": 1920,
      "height": 1280,
      "aspect_ratio": 1.5,
      "pixels": 2457600,
      "tags": [
        "bird",
        "feathers",
        "beak"
      ],
      "url": "http://res.cloudinary.com/cloud_name/image/upload/v1572953304/birds/rjgx7odwsqj8v6r3hxpr.jpg",
      "secure_url": "https://res.cloudinary.com/cloud_name/image/upload/v1572953304/birds/rjgx7odwsqj8v6r3hxpr.jpg",
      "status": "active",
      "access_mode": "public",
      "access_control": null,
      "etag": "284e8a1e18f013ab644b00be32003fed"
    },
    {
      "public_id": "birds/tkdkwjlvuj4wwpnjnzww",
      "display_name": "eagle",
      "asset_folder": "birds",
      "filename": "tkdkwjlvuj4wwpnjnzww",
      "format": "jpg",
      "version": 1572953310,
      "resource_type": "image",
      "type": "upload",
      "created_at": "2019-11-05T11:28:30+00:00",
      "uploaded_at": "2019-11-05T11:28:30+00:00",
      "bytes": 365870,
      "backup_bytes": 0,
      "width": 1920,
      "height": 1280,
      "aspect_ratio": 1.5,
      "pixels": 2457600,
      "tags": [
        "beak",
        "bird",
        "feathers"
      ],
      "url": "http://res.cloudinary.com/cloud_name/image/upload/v1572953310/birds/tkdkwjlvuj4wwpnjnzww.jpg",
      "secure_url": "https://res.cloudinary.com/cloud_name/image/upload/v1572953310/birds/tkdkwjlvuj4wwpnjnzww.jpg",
      "status": "active",
      "access_mode": "public",
      "access_control": null,
      "etag": "534b82b763b375a47169bcb5b2cceabc"
    }
  ]
}

This time, let the response show only the public_id and the tags (-ff public_id,tags):

cld search -f tags -ff public_id,tags -n 30 -s public_id asc "resource_type:image AND tags=bird AND uploaded_at>1d AND bytes>100k"

Sample output:

{
  "total_count": 4,
  "time": 177,
  "resources": [
    {
      "public_id": "birds/ndnqgfjucvqt0aagrv0d",
      "tags": [
        "beak",
        "bird",
        "feathers"
      ]
    },
    {
      "public_id": "birds/pa6o8xvvbg22dceytes0",
      "tags": [
        "beak",
        "bird",
        "feathers"
      ]
    },
    {
      "public_id": "birds/rjgx7odwsqj8v6r3hxpr",
      "tags": [
        "beak",
        "bird",
        "feathers"
      ]
    },
    {
      "public_id": "birds/tkdkwjlvuj4wwpnjnzww",
      "tags": [
        "beak",
        "bird",
        "feathers"
      ]
    }
  ]
}

provisioning

The provisioning command enables you to run any methods that can be called through the provisioning API. The provisioning API enables you to create and manage product environments, users and user groups. The provisioning API is available for Enterprise plan upon request.

See the Provisioning API reference for details about each of the methods.

To call provisioning methods:

• Your product environment needs to be set up for provisioning.

• You need to set up your CLOUDINARY_ACCOUNT_URL environment variable, which takes the form <PROVISIONING_API_KEY>:<PROVISIONING_API_SECRET>@<ACCOUNT_ID>. To set a temporary environment variable, for example:

  • On Mac or Linux:
    export CLOUDINARY_ACCOUNT_URL=account://1234567890abcdef1234567890abcd:XYzPRB1Q8QP3ijBM2ipU5GeMHWk@1234abcd-1234-123a-1a2b-12345678901a

  • On Windows:
    set CLOUDINARY_ACCOUNT_URL=account://1234567890abcdef1234567890abcd:XYzPRB1Q8QP3ijBM2ipU5GeMHWk@1234abcd-1234-123a-1a2b-12345678901a

  Tip

  You can copy and paste the component parts of your CLOUDINARY_ACCOUNT_URL from the Provisioning API Access section of the Account page in the Cloudinary Console Settings. If your account is not set up for provisioning (available upon request for Enterprise plans), you won't see this section.

Syntax

Command options

Methods

Use cld provisioning to list all of the available provisioning API methods. Then refer to the Provisioning API reference to see the parameters applicable to each method.

For example, the method, update_user, has one required parameter, user_id, and various optional parameters. To update the role of a user with id 7f08f1f1fc910bf1f25274aef11d27 to admin, enter:

cld provisioning update_user "7f08f1f1fc910bf1f25274aef11d27" -o role "admin"

Examples

Create a product environment called docs-demo, with a cloud called docs-demo-cloud, based on the existing product environment with ID, 0918b03ea306482e4858ee1ac2e7c8:

cld provisioning create_sub_account docs-demo cloud_name=docs-demo-cloud base_account=0918b03ea306482e4858ee1ac2e7c8

Sample response:

{
  "id": "7ad7f4e93ba3f349ee63642fb68e42",
  "name": "docs-demo",
  "description": null,
  "cloud_name": "docs-demo-cloud",
  "api_access_keys": [
    {
      "key": "123456789012345",
      "secret": "LbZYhvmGyklH5rF1iHUfOpMugew",
      "enabled": true
    }
  ],
  "enabled": true,
  "created_at": "2020-09-03T13:09:59Z",
  "custom_attributes": null
}

Create a user called John Smith, whose email address is johnsmith@example.com, with the media_library_user role and access to product environments with IDs: 0918b03ea306482e4858ee1ac2e7c8 and 7ad7f4e93ba3f349ee63642fb68e42:

cld provisioning create_user "John Smith" "johnsmith@example.com" "media_library_user" sub_account_ids=0918b03ea306482e4858ee1ac2e7c8,7ad7f4e93ba3f349ee63642fb68e42

Sample response:

{
  "id": "6a40b071a86d040ddf37f2dfb736fd",
  "name": "John Smith",
  "role": "media_library_user",
  "email": "johnsmith@example.com",
  "pending": true,
  "enabled": true,
  "created_at": "2020-09-08T10:06:14Z",
  "all_sub_accounts": false,
  "groups": [],
  "sub_account_ids": "0918b03ea306482e4858ee1ac2e7c8,7ad7f4e93ba3f349ee63642fb68e42"
}

migrate

Use the migrate command to migrate a list of external media files to Cloudinary. The URLs of the files to migrate are listed in a separate file and must all have the same prefix.

Syntax

Command options

upload_mapping

An auto-upload URL mapping that you have configured in your product environment Upload Settings. Set upload_mapping to the name of the mapped folder.

file

The name of the file containing the URLs that each have the same URL prefix as specified in the auto-upload URL mapping.

Example

You have a file of URLs that point to assets that you want to migrate to your Cloudinary product environment. In this example, all the assets are prefixed by 'https://upload.wikimedia.org/wikipedia/commons/' and the URLs in the file are delimited by semicolons.

The file, called url_file.txt, looks like this:

https://upload.wikimedia.org/wikipedia/commons/c/cb/Eden_Gardens_under_floodlights_during_a_match.jpg;https://upload.wikimedia.org/wikipedia/commons/d/dc/Historical_cricket_bat_art.jpg;https://upload.wikimedia.org/wikipedia/commons/a/ae/Olympic_flag.jpg;https://upload.wikimedia.org/wikipedia/commons/3/35/Olympic-flag-Victoria.jpg

First, configure an auto-upload URL mapping in your product environment Upload Settings that maps a Cloudinary folder, for example, 'remote_media', to the URL prefix 'https://upload.wikimedia.org/wikipedia/commons/'. The folder will be created in Cloudinary automatically if it does not already exist.

You can create the upload mapping in the Cloudinary Console Upload Settings, or using the CLI as follows:

cld admin create_upload_mapping "remote_media" template="https://upload.wikimedia.org/wikipedia/commons/"

Then, run this command to migrate all the assets in url_file.txt to the remote_media folder in your Cloudinary product environment, returning 'verbose' output:

cld migrate -v -d ";" remote_media url_file.txt

Sample verbose output:

Uploaded http://res.cloudinary.com/cloud_name/image/upload/v1/remote_media/c/cb/Eden_Gardens_under_floodlights_during_a_match.jpg
Uploaded http://res.cloudinary.com/cloud_name/image/upload/v1/remote_media/d/dc/Historical_cricket_bat_art.jpg
Uploaded http://res.cloudinary.com/cloud_name/image/upload/v1/remote_media/a/ae/Olympic_flag.jpg
Uploaded http://res.cloudinary.com/cloud_name/image/upload/v1/remote_media/3/35/Olympic-flag-Victoria.jpg

clone

Use the clone command to copy assets from one product environment to another. You can optionally include tags and context with the assets.

The source product environment is the one you've configured for the CLI. You can specify a different source product environment using the -c or -C options.

Syntax

Command options

target_environment

The product environment that you want to clone the assets to. You can specify a CLOUDINARY_URL environment variable or a saved config.

Examples

Copy all assets including tags and context to the product environment specified by its CLOUDINARY URL environment variable:

cld clone cloudinary://123456789012345:abcdefghijklmnopqrstuvwxyzA@cloud_name -fi tags,context

Copy all assets with the tag, "animals", to the product environment specified by the saved config, "my_config":

cld clone my_config -se "tags:animals"

sync

The sync command synchronizes between a local folder and a Cloudinary folder, maintaining the folder structure.

Syntax

Command options

local_folder

Your local folder that you want to synchronize with your Cloudinary folder.

cloudinary_folder

The full path of the Cloudinary folder that you want to synchronize with your local folder. You can specify a path by separating folders with a forward slash.

• In fixed folder mode, the cloudinary_folder is the first part of the public ID of the uploaded assets (up to the final forward slash).
• In dynamic folder mode, the cloudinary_folder is the asset folder of the uploaded assets.

Example

Push changes from the local folder, my_images, to the Cloudinary folder, my_cld_images/my_images.

cld sync --push my_images my_cld_images/my_images

Sample output:

Found 7 items in local folder 'my_images'
Found 0 items in Cloudinary folder 'my_cld_images/my_images'
Uploading 7 items to Cloudinary folder 'my_cld_images/my_images'
Successfully uploaded /Users/me/my_images/hummingbird.jpg as my_cld_images/my_images/hummingbird
Successfully uploaded /Users/me/my_images/jay.jpg as my_cld_images/my_images/jay
Successfully uploaded /Users/me/my_images/bird.jpg as my_cld_images/my_images/bird
Successfully uploaded /Users/me/my_images/kingfisher.jpg as my_cld_images/my_images/kingfisher
Successfully uploaded /Users/me/my_images/ara.jpg as my_cld_images/my_images/ara
Successfully uploaded /Users/me/my_images/parrot.jpg as my_cld_images/my_images/parrot
Successfully uploaded /Users/me/my_images/swan.jpg as my_cld_images/my_images/swan
Done!

Subsequently, delete two files from the Cloudinary folder. Now pull the changes back down to the local folder with the -F option so as not to be prompted for confirmation to delete files:

cld sync -F --pull my_images my_cld_images/my_images

Sample output:

Found 7 items in local folder 'my_images'
Found 5 items in Cloudinary folder 'my_cld_images/my_images'
Skipping 5 items
Deleting 2 local files...
Deleted '/Users/me/my_images/swan.jpg'
Deleted '/Users/me/my_images/kingfisher.jpg'
Deleting empty folders...
Downloading 0 files from Cloudinary
Done!

upload_dir

Use the upload_dir command to upload a folder of assets, maintaining the folder structure.

Syntax

Command options

local_folder

Your local folder that you want to upload to Cloudinary. If this argument is omitted, the contents of the current folder are uploaded.

Examples

Upload the local folder, my_images, and all its contents and sub-folders to the Cloudinary folder my_images_on_cloudinary, overwriting existing files.

cld upload_dir -f my_images_on_cloudinary -o overwrite true my_images

This results in the following folder structure in Cloudinary:

    Home
    +--my_images_on_cloudinary
    |  +-- my_images
    |  |   +-- <all assets and sub-folders of my_images>

As above, but excluding the parent folder name, my_images.

cld upload_dir -e -f my_images_on_cloudinary -o overwrite true my_images

This results in the following folder structure in Cloudinary:

    Home
    +--my_images_on_cloudinary
    |  +-- <all assets and sub-folders of my_images>

This video shows the upload_dir command in action:

Video Player is loading.

Play Video

Play

Unmute

Current Time 0:00

/

Duration 0:00

Loaded: 0%

Stream Type LIVE

Seek to live, currently behind liveLIVE

Remaining Time -0:00

 

1x

Playback Rate

• 2x
• 1.5x
• 1.25x
• 1x, selected
• 0.5x

Descriptions

• descriptions off, selected

Captions

• captions off, selected

Audio Track

Fullscreen

This is a modal window.

Tutorial contents

regen_derived

Use the regen_derived command to regenerate all derived assets created using a specific named transformation or transformation string. For example, you may want to use this after updating a named transformation definition in order to invalidate the existing derived assets and repopulate the cache with up-to-date versions of the assets.

Syntax

Command options

transformation_name

Either the name of a named transformation, for example, black-border, or a transformation string, for example t_black-border/a_50/l_icon/fl_layer_apply,g_west.

Examples

Asynchronously regenerate all assets that have been derived using the named transformation called small-square, skipping the initial confirmation, and notify a specific webhook.

cld regen_derived 'small-square' -F -A -ea -enu 'https://mysite.example.com/my_notification_endpoint'

Sample response:

Regenerating 2 derived asset(s) with eager_async=True...
Processing https://res.cloudinary.com/demo/image/upload/t_small-square/v1695889160/cld-sample.jpg
Processing https://res.cloudinary.com/demo/image/upload/t_small-square/v1695898027/docs/luggage.jpg
Regeneration in progress. It may take up to 10 mins to see the changes. Please contact support if you still see the old media.

Regenerate all assets that have been derived using the transformation string t_small-square/f_avif,fl_aavif/a_30/jpg, skipping the initial confirmation.

cld regen_derived 't_small-square/f_avif,fl_aavif/a_30/jpg' -F -A

Sample response:

Regenerating 3 derived asset(s)...
Regenerated https://res.cloudinary.com/demo/image/upload/t_small-square/f_avif,fl_aavif/a_30/v1690196527/docs/garden-gnome.jpg
Regenerated https://res.cloudinary.com/demo/image/upload/t_small-square/f_avif,fl_aavif/a_30/v1691056801/docs/men-laughing.jpg
Regenerated https://res.cloudinary.com/demo/image/upload/t_small-square/f_avif,fl_aavif/a_30/v1690537544/docs/ladies-smiling.jpg
Regeneration complete. It may take up to 10 mins to see the changes. Please contact support if you still see the old media.

utils

The utils command enables you to run Cloudinary utility methods.

Syntax

Command options

Methods

Use cld utils to list all of the available utility methods. Refer to the links in the table below to see the parameters applicable to each method.

Examples

Generate a signature, where the parameters to sign are '{"timestamp": 1595793040, "public_id": "flower"}' and the API secret is 323127161127519:

cld utils api_sign_request '{"timestamp": 1595793040, "public_id": "flower"}' 323127161127519

Sample output:

a1983942190b20a6b40849751032022914c25bd3

Generate the URL to deliver the asset with public ID, sample, scaled to a width of 300 pixels and a height of 100 pixels.

cld utils cloudinary_url sample width=300 height=100 crop=scale

Sample output:

http://res.cloudinary.com/demo/image/upload/c_scale,h_100,w_300/sample

make

The make command returns template code for implementing the specified Cloudinary widget or functionality.

Syntax

Command options

language

template

Examples

Generate sample code for implementing a basic upload widget in your web page.

cld make upload_widget

Sample output:

<button id="upload_widget" class="cloudinary-button">Upload files</button>

<script src="https://widget.cloudinary.com/v2.0/global/all.js" type="text/javascript"></script>  

<script type="text/javascript">  

    var myWidget = cloudinary.createUploadWidget({
        cloudName: 'cloud_name',
        upload_preset: 'preset1',
        }, (error, result) => { if (result.event == "success") {
            console.log(result.info) // result.info contains data from upload
        } })

        document.getElementById("upload_widget").addEventListener("click", function(){
            myWidget.open();
        }, false);

</script>

Generate sample Python code for finding all empty folders.

cld make python find_all_empty_folders

Sample output:

import cloudinary

cloudinary.config(**{
    "cloud_name": "cloud_name",
    "api_key": "123456789012345",
    "api_secret": "abcde"
})


from cloudinary import api

def find_end(root, f):
    root = root.replace(" " , "%20")
    res = list(filter(lambda x: x != 'search', list(map(lambda x: x['path'], api.subfolders(root)['folders']))))
    tmp = [find_end(i, f) for i in res] if res != [] else f.append(root)
    if root == "": return f

empty = list(filter(lambda x: cloudinary.Search().expression("folder:{}".format(x)).execute()['total_count'] == 0, find_end("", [])))

print("Empty folders:\n{}".format(empty))

url

The url command generates a Cloudinary URL, which you can optionally open in your browser.

Syntax

Command options

transformation

The transformation that you want to perform on the asset. Use the URL syntax as described in the Transformation URL API Reference.

Examples

Perform the following transformation on the image with public ID docs/animals_on_road:

• Resize to width to 400 pixels using the thumb cropping mode with automatic gravity
• Apply a vectorize effect using 10 colors and a detail of 60%
• Add a vignette effect with a strength of 40.

cld url -t upload -o docs/animals_on_road.jpg w_400,c_thumb,g_auto,e_vectorize:10:0.6/e_vignette:40

Sample output:

http://res.cloudinary.com/demo/image/upload/w_400,c_thumb,g_auto,e_vectorize:10:0.6/e_vignette:40/docs/animals_on_road.jpg

Use the URL2PNG add-on to capture a screenshot of the top part of the Cloudinary home page, apply a grayscale effect to the captured image, and open the transformed image in the browser. As the URL2PNG add-on requires URLs to be signed, the -s option is used.

cld url -t url2png -o -s https://cloudinary.com w_300,h_250,g_north,c_fill,e_grayscale

Sample output:

http://res.cloudinary.com/cloud_name/image/url2png/s--6WjWrdiu--/w_300,h_250,g_north,c_fill,e_grayscale/https://cloudinary.com

config

A configuration is a reference to a specified Cloudinary product environment via its environment variable. You set the default configuration during installation and configuration. Using different configurations allows you to access different Cloudinary product environments.

The config command displays the current configuration and lets you manage additional configurations.

You can specify the environment variable of additional Cloudinary product environments either explicitly (-c option) or as a saved configuration (-C option).

For example, using the -c option:

cld -c cloudinary://123456789012345:abcdefghijklmnopqrstuvwxyzA@cloud_name admin usage

Whereas using the saved configuration "accountx":

cld -C accountx admin usage

You can create, delete and list saved configurations using the config command.

See also: Setting configuration parameters

Syntax

Options

Examples

In these examples, we use a made up environment variable.

Display the current configuration.

cld config

Create an additional configuration named accountx, display its details, show the upload presets that are configured in this product environment, then delete the configuration.

cld config -n accountx cloudinary://123456789012345:abcdefghijklmnopqrstuvwxyzA@cloud_name

cld config -s accountx

cld -C accountx admin upload_presets

cld config -rm accountx

Create an additional configuration from an environment variable. The configuration is automatically given the same name as the cloud name, in this case cloud_name. Then upload a picture to the product environment, applying relevant tags.

cld config -url cloudinary://123456789012345:abcdefghijklmnopqrstuvwxyzA@cloud_name

cld -C cloud_name uploader upload "family.jpg" tags="mum,dad,grandpa,grandma"

List all saved configurations to a file called configs.txt, then delete all the configurations.

cld config -ls > configs.txt

while read in; do cld config -rm "$in"; done < configs.txt