Command Line Interface (CLI)
A versatile command-line interface tool for seamless server-side interaction with the headless DAM API
Last updated
A versatile command-line interface tool for seamless server-side interaction with the headless DAM API
Last updated
©2024 Scaleflex SAS
The CLI is a command-line interface tool designed to interact with the DAM API. It enables server-side use and provides a convenient way to perform various operations on digital assets, such as uploading, downloading, deleting, moving and renaming files. Additionally, it allows users to list and query asset information, including tags and metadata.
The DAM CLI provides all the functionality of DAM and its APIs. It can be used from the terminal or in a script to access the features of Scaleflex DAM in a convenient way. Using the tool, all media assets can be managed via simple commands on macOS or Linux.
For example, you can perform Admin and Upload API operations by typing commands directly into a terminal. This saves you time as you do not need to set up a development environment. You can also build scripts with multiple CLI commands to implement more complex processes and workflows.
Complete documentation of the tool is available on its GitHub page:
What follows is a brief introduction and a quick-start guide to get you up to speed in no time.
The DAM CLI provides a range of use cases that demonstrate its versatility:
Bulk upload - Upload a large number of assets to the DAM in a single command, saving time and effort;
Automated workflows - Incorporate the CLI application into server-side scripts or workflows to perform scheduled asset management tasks;
Asset manipulation - Rename, move or delete assets based on specific criteria;
Metadata management - Query and update asset metadata;
Backup and recovery - Download assets from the DAM for backup or recovery purposes;
Integration with other systems - Integrate the CLI into third-party tools or systems for seamless asset management.
The features of DAM CLI include:
Uploading/Downloading multiple assets;
Batch asset deletion;
Listing assets;
Querying asset information such as metadata, tags, etc.;
Moving assets between folders;
Renaming assets.
The following DAM APIs are supported: Delete, Download, Inspect, List, Move, Product, Rename and Upload.
Complete information about the Filerobot API endpoints is available in an always up-to-date documentation, that can be accessed via the following link:
There, you can find details about the API endpoints, together with all required request parameters, so you know how to interact with them.
Filerobot API can be installed by running one of the following commands depending on your operating system. They download the latest release of the tool from the GitHub page, move it to an appropriate directory and make it available for use.
You can confirm that the installation was successful by running:
The version of the tool should appear on the screen:
Configuring the CLI requires a DAM Token (mytoken) and API Secret Key (mysupersecretkey) both of which are available from the Filerobot Asset Hub.
The following commands are available:
config
sets the token and key provided by Scaleflex, required to use the tool
delete
deletes a file by UUID
download
downloads a file by path or UUID
help
displays the help info for a command
inspect
gets file information by UUID
list
lists files and directories from your Filerobot store
move
moves files to a new folder. The folder is created if it doesn't exist
product
allows access to the Product API functionalities
rename
renames a file by UUID.
upload
uploads a file to a specific folder
version
prints the version number of Filerobot CLI
Additional info for any command can be accessed using filerobot [command] --help.
Inspect the current token and key:
List the contents of a directory:
Inspect a specific resource:
Download a file by UUID:
Upload a file to a specific folder:
Upload all .jpg images in the current directory:
