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 making them more readable and easier to maintain. |
JFrog CLI works with JFrog Artifactory, Xray, Distribution and Mission Control, (through their respective REST APIs) making your scripts more efficient and reliable in several ways:
Parallel uploads and downloads
JFrog CLI allows you to upload and download artifacts concurrently by a configurable number of threads that help your automated builds run faster. For big artifacts, you can define a number of chunks to split files 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. With checksum optimization, long upload and download operations can be paused in the middle, and then be continued later where they were left off.
Flexible uploads and downloads
JFrog CLI supports uploading files to Artifactory using wildcard patterns, regular expressions and ANT patterns, giving you an easy way to collect all the files you wish to upload. You can also download files using wildcard patterns.
Upload and download preview
All upload and download 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.
|
JFrog CLI v2
Overview
We have recently released JFrog CLI v2, which includes changes to the functionality and usage of some of the legacy JFrog CLI commands. The changes are the result of feedback we received from users over time through GitHub, making the usage and functionality easier and more intuitive. For example, some of the default values changed, and are now more consistent across different commands. We also took this opportunity for improving and restructuring the code, as well as replacing old and deprecated functionality.
Most of the changes included in v2 are breaking changes compared to the v1 releases. We therefore packaged and released these changes under JFrog CLI v2, allowing users to migrate to v2 only when they are ready.
We intend to keep v1 available. Future enhancements however are planned to be introduced as part of v2. We therefore encourage users to migrate from the legacy releases to v2.
List of changes in JFrog CLI v2
- The default value of the --flat option is now set to false for the jfrog rt upload command.
- The deprecated syntax of the jfrog rt mvn command is no longer supported. To use the new syntax, the project needs to be first configured using the jfrog rt mvnc command.
- The deprecated syntax of the jfrog rt gradle command is no longer supported. To use the new syntax, the project needs to be first configured using the jfrog rt gradlec command.
- The deprecated syntax of the jfrog rt npm and jfrog rt npm-ci commands is no longer supported. To use the new syntax, the project needs to be first configured using the jfrog rt npmc command.
- The deprecated syntax of the jfrog rt go command is no longer supported. To use the new syntax, the project needs to be first configured using the jfrog rt go-config command.
- The deprecated syntax of the jfrog rt nuget command is no longer supported. To use the new syntax, the project needs to be first configured using the jfrog rt nugetc command.
- All Bintray commands are removed.
- The jfrog rt config command is removed and replaced by the jfrog config add command.
- The jfrog rt use command is removed and replaced with the jfrog config use.
- The --props command option and props file spec property for the jfrog rt upload command are removed, and replaced with the --target-props command option and targetProps file spec property respectively.
The following commands are removed
jfrog rt release-bundle-create jfrog rt release-bundle-delete jfrog rt release-bundle-distribute jfrog rt release-bundle-sign jfrog rt release-bundle-update
and replaced with the following commands respectively
jfrog ds release-bundle-create jfrog ds release-bundle-delete jfrog ds release-bundle-distribute jfrog ds release-bundle-sign jfrog ds release-bundle-update
- The jfrog rt go-publish command now only supports Artifactory version 6.10.0 and above. Also, the command no longer accepts the target repository as an argument. The target repository should be pre-configured using the jfrog rt go-config command.
- The jfrog rt go command no longer falls back to the VCS when dependencies are not found in Artifactory.
- The --deps, --publish-deps, --no-registry and --self options of the jfrog rt go-publish command are now removed.
- The --apiKey option is now removed. The API key should now be passed as the value of the --password option.
- The --exclude-patterns option is now removed, and replaced with the --exclusions option. The same is true for the excludePatterns file spec property, which is replaced with the exclusions property.
- The JFROG_CLI_JCENTER_REMOTE_SERVER and JFROG_CLI_JCENTER_REMOTE_REPO environment variables are now removed and replaced with the JFROG_CLI_EXTRACTORS_REMOTE environment variable.
- The JFROG_CLI_HOME environment variable is now removed and replaced with the JFROG_CLI_HOME_DIR environment variable.
- The JFROG_CLI_OFFER_CONFIG environment variable is now removed and replaced with the CI environment variable. Setting CI to true disables all prompts.
- The directory structure is now changed when the jfrog rt download command is used with placeholders and --flat=false (--flat=false is now the default). When placeholders are used, the value of the --flat option is ignored.
- When the jfrog rt upload command now uploads symlinks to Atyifctory, the target file referenced by the symlink is uploaded to Artifactory with the symlink name. If the --symlink options is used, the symlink itself (not the referenced file) is uploaded, with the referenced file as a property attached to the file.
Download and Installation of JFrog CLI
To download the executable, please visit the .
You can also download the sources from the 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 .
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: |
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] This variable determines the log level of the JFrog CLI. |
JFROG_CLI_HOME_DIR | [Default: ~/.jfrog] Defines the JFrog CLI home directory. |
JFROG_CLI_TEMP_DIR | [Default: The operating system's temp directory] Defines the temp directory used by JFrog CLI. |
CI | [Default: false] If true, disables interactive prompts and progress bar. |
JFrog Platform Configuration
Adding and Editing Configured Servers
The config add and config edit commands are used to add and edit JFrog Platform server configuration, stored in JFrog CLI's configuration storage. These configured servers can be used by the other commands. The configured servers' details can be overridden per command by passing in alternative values for the URL and login credentials. The values configured are saved in file under the JFrog CLI home directory.
Command name | config add / config edit |
Abbreviation | c add / c edit |
Command options | |
| --access-token | [Optional] Access token. |
| --artifactory-url | [Optional] Artifactory URL. |
| --basic-auth-only | [Default: false] Used for Artifactory authentication. Set to true to disable replacing username and password/API key with automatically created access token that's refreshed hourly. Username and password/API key will still be used with commands which use external tools or the JFrog Distribution service. Can only be passed along with username and password/API key options. |
| --client-cert-key-path | [Optional] Private key file for the client certificate in PEM format. |
| --client-cert-path | [Optional] Client certificate file in PEM format. |
| --dist-url | [Optional] Distribution URL. |
| --enc-password | [Default: true] If true, the configured password will be encrypted using Artifactory's encryption API before being stored. If false, the configured password will not be encrypted. |
--insecure-tls | Default: false] Set to true to skip TLS certificates verification, while encrypting the Artifactory password during the config process. |
--interactive | [Default: true, unless $CI is true] Set to false if you do not want the config command to be interactive. |
--mission-control-url | [Optional] Mission Control URL. |
| --password | [Optional] JFrog Platform password. |
| --pipelines-url | [Optional] Pipelines URL. |
| --ssh-key-path | [Optional] For authentication with Artifactory. SSH key file path. |
| --url | [Optional] JFrog platform URL. |
| --user | [Optional] JFrog Platform username. |
| --xray-url | [Optional] Xray URL. |
| --overwrite | [Available for config add only] [Default: false] Overwrites the instance configuration if an instance with the same ID already exists. |
Command arguments | |
| server ID | A unique ID for the server configuration. |
Removing Configured Servers
The config remove command is used to remove JFrog Platform server configuration, stored in JFrog CLI's configuration storage.
Command name | config remove |
Abbreviation | c rm |
Command options | |
--quiet | [Default: $CI] Set to true to skip the delete confirmation message. |
Command arguments | |
| server ID | The server ID to remove. If no argument is sent, all configured servers are removed. |
Showing the Configured Servers
The config show command shows the stored configuration. You may show a specific server's configuration by sending its ID as an argument to the command.
Command name | config show |
Abbreviation | c s |
Command arguments | |
| server ID | The ID of the server to show. If no argument is sent, all configured servers are shown. |
Setting a Server as Default
The config use command sets a configured server as default. The following commands will use this server.
Command name | config use |
Command arguments | |
| server ID | The ID of the server to set as default. |
Exporting and Importing Configuration
The config export command generates a token, which stores the server configuration. This token can be used by the config import command, to import the configuration stored in the token, and save it in JFrog CLI's configuration storage.
Export
Command name | config export |
Abbreviation | c ex |
Command arguments | |
| server ID | The ID of the server to export |
Import
Command name | config import |
Abbreviation | c im |
Command arguments | |
| server ID | The token to import |
Setting up a CI Pipeline
The ci-setup command allows setting up a basic CI pipeline with the JFrog Platform, while automatically configuring the JFrog Platform to serve the pipeline. It is an interactive command, which prompts you with a series for questions, such as your source control details, your build tool, build command and your CI provider. The command then uses this information to do following:
- Create the repositories in JFrog Artifactory, to be used by the pipeline to resolve dependencies.
- Configure JFrog Xray to scan the build.
- Generate a basic CI pipeline, which builds and scans your code.
You can use the generated CI pipeline as a working starting point and then expand it as needed.
The command currently supports the following package managers:
- Maven
- Gradle
- npm.
and the following CI providers:
- JFrog Pipelines
- Jenkins
- GitHub Actions.
Usage:
jfrog ci-setup |
Proxy Support
JFrog CLI supports using an HTTP/S proxy. All you need to do is set HTTP_PROXY or HTTPS_PROXY environment variable with the proxy URL.
HTTP_PROXY, HTTPS_PROXY and NO_PROXY are the industry standards for proxy usages.
Variable Name | Description |
HTTP_PROXY | Determines a URL to an HTTP proxy. |
HTTPS_PROXY | Determines a URL to an HTTPS proxy. |
NO_PROXY | Use this variable to bypass the proxy to IP addresses, subnets or domains. This may contain a comma-separated list of hostnames or IPs without protocols and ports. A typical usage may be to set this variable to Artifactory’s IP address. |
Bash and Zsh Auto-Completion
If you're using JFrog CLI from a bash or zsh shells, you can install JFrog CLI's auto-completion scripts.
If you're installing JFrog CLI using Homebrew, the bash auto-complete scripts are automatically installed by Homebrew. Please make sure that your .bash_profile is configured as described in the Homebrew Shell Completion documentation. |
With your favourite text editor, open $HOME/.zshrc and add ‘jfrog’ to the plugin list. For example: plugins=(git mvn npm sdk jfrog) |
To install auto-completion for bash, run the following command and follow the instructions to complete the installation.
jfrog completion bash |
To install auto-completion for zsh, run the following command and follow the instructions to complete the installation.
jfrog completion zsh |
Sensitive Data Encryption
Since version 1.37.0, JFrog CLI supports encrypting the sensitive data stored in JFrog CLI's config. To enable encryption, follow these steps.
- Create a random 32 character master key. Make sure that the key size is exactly 32 characters. For example f84hc22dQfhe9f8ydFwfsdn48!wejh8A
Create a file named
security.yamlunder~/.jfrog/security.If you modified the default JFrog CLI home directory by setting JFROG_CLI_HOME_DIR environment variable, then the
security/security.yamlfile should br created under the configured home directory.Add the master key you generated to security.yaml. The file content should be:
version: 1 masterKey: "<your master key>" |
- Make sure that the only permission security.yaml has is read for the user running JFrog CLI.
The configuration will be encrypted the next time JFrog CLI attempts to access the config.
When upgrading JFrog CLI from a version prior to 1.37.0 to version 1.37.0 or above, JFrog CLI automatically makes changes to the content of the ~/ |
JFrog CLI Plugins
General
JFrog CLI Plugins allow enhancing the functionality of JFrog CLI to meet the specific user and organization needs. The source code of a plugin is maintained as an open source Go project on GitHub. All public plugins are registered in JFrog CLI's Plugins Registry. We encourage you, as developers, to create plugins and share them publicly with the rest of the community. When a plugin is included in the registry, it becomes publicly available and can be installed using JFrog CLI. Read the JFrog CLI Plugins Developer Guide if you wish to create and publish your own plugins.
Installing Plugins
A plugin which is included JFrog CLI's Plugins Registry can be installed using the following command.
$ jfrog plugin install the-plugin-name |
This command will install the plugin from the official public registry by default. You can also install a plugin from a private JFrog CLI Plugin registry, as described in the Private Plugins Registries section.
Private Plugins Registries
In addition to the public official JFrog CLI Plugins Registry, JFrog CLI supports publishing and installing plugins to and from private JFrog CLI Plugins Registries. A private registry can be hosted on any Artifactory server. It uses a local generic Artifactory repository for storing the plugins.
To create your own private plugins registry, follow these steps.
- On your Artifactory server, create a local generic repository named jfrog-cli-plugins.
- Make sure your Artifactory server is included in JFrog CLI's configuration, by running the jfrog c show command.
- If needed, configure your Artifactory instance using the jfrog c add command.
- Set the ID of the configured server as the value of the JFROG_CLI_PLUGINS_SERVER environment variable.
- If you wish the name of the plugins repository to be different than jfrog-cli-plugins, set this name as the value of the JFROG_CLI_PLUGINS_REPO environment variable.
The jfrog plugin install command will now install plugins stored in your private registry.
To publish a plugin to the private registry, run the following command, while inside the root of the plugin's sources directory. This command will build the sources of the plugin for all the supported operating systems. All binaries will be uploaded to the configured registry.
jfrog plugin publish the-plugin-name the-plugin-version |
Release Notes
Release notes for JFrog CLI v2
Release notes for the legacy releases of JFrog CLI