JFrog CLI

Welcome to JFrog CLI

JFrog CLI is a compact and smart client that provides a simple interface that automates access to JFrog products simplifying your automation scripts and making them more readable and easier to maintain. JFrog CLI works with JFrog Artifactory, JFrog Mission Control, JFrog Bintray and JFrog Xray (through their respective REST APIs) making your scripts more efficient and reliable in several ways:

Parallel uploads and downloads

JFrog CLI lets you upload and download artifacts concurrently by a configurable number of threads which helps your automated builds run faster. For big artifacts, you can even define a number of chunks into which files should be split for parallel download.

Checksum optimization

JFrog CLI optimizes both upload and download operations by skipping artifacts that already exist in their target location. Before uploading an artifact, JFrog CLI queries Artifactory with the artifact's checksum. If it already exists in Artifactory's storage, the CLI skips sending the file, and, if necessary, Artifactory only updates its database to reflect the artifact upload. Similarly when downloading an artifact from Artifactory. If the artifact already exists in the same download path, it will be skipped. Thanks to checksum optimization, long upload and download operations can be stopped in the middle and then be continued later where they left off.

Wildcards and regular expressions

JFrog CLI supports wildcards and regular expressions giving you an easy way to collect all the artifacts you wish to upload or download.

Upload preview

All upload operations can be used with the --dry-run option to give you a preview of all the files that would be uploaded with the current command.

Page Contents

Download and Installation

To download the executable, please visit the JFrog CLI Download Site.

You can also download the sources from the JFrog CLI Project on GitHub where you will also find instructions on how to build JFrog CLI.

System Requirements

JFrog CLI runs on any modern OS that fully supports the Go programming language.

Usage

To use the CLI, place the executable anywhere in your file system and add its location to your PATH environment variable. While the basic command syntax is the same for all products, the available commands may vary depending on which product you are working with.

Syntax

$ jfrog target command-name global-options command-options arguments

Where:

target	The product on which you wish to execute the command: rt: JFrog Artifactory bt: JFrog Bintray mc: JFrog Mission Control xr: JFrog Xray
command-name	The command to execute. Note that you can use either the full command name or its abbreviation.
global-options	A set of global options specifying the product URL and means of authentication. These may be used for all commands
command-options	A set of options corresponding to the command
arguments	A set of arguments corresponding to the command

Environment Variables

JFrog CLI makes use of the following environment variables:

Variable Name

Description

JFROG_CLI_LOG_LEVEL

[Default: INFO]

If set to ERROR, JFrog CLI logs error messages only. It is useful when you wish to read or parse the JFrog CLI output and do not want any other information logged.

JFROG_CLI_OFFER_CONFIG

[Default: true]

If true, JFrog CLI prompts for product server details and saves them in its config file. To avoid having automation scripts interrupted, set this value to false, and instead, provide product server details using the config command.