Need help with other JFrog products?
JFrog Enterprise+
JFrog Artifactory
JFrog Xray
JFrog Mission Control
JFrog Distribution
[JFrog Pipelines]
JFrog Bintray
JFrog Access
Announcing: The New JCenter!
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.
JFrog CLI runs on any modern OS that fully supports the Go programming language.
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.
$ 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 |
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_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 |
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 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. |
If you're using JFrog CLI from a bash or zsh shells, you can install JFrog CLI's auto-completion scripts.
install JFrog CLI with Homebrew?
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.
Using Oh My Zsh?
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
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 file named security.yaml
under ~/.jfrog/
security
.
If you modified the default JFrog CLI home directory by setting JFROG_CLI_HOME_DIR environment variable, then the security/security.yaml
file 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>"
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
directory, to support the new functionality introduced in version 1.37.0. Before making these changes, the content of the ~/.jfrog
directory is backed up inside the ~/.jfrog/backup
directory. Therefore, after enabling sensitive data encryption, it is recommended to remove the backup
directory, to ensure no sensitive data is left unencrypted.
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.
Version 1.41.1 or above is required. Plugins can be installed using the following JFrog CLI command.
$ jfrog plugin install the-plugin-name
Read the JFrog CLI Plugins Developer Guide if you wish to create and publish your own plugins.
JFrog CLI release notes are available on Bintray.