Need help with other JFrog products?
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.
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.
The product on which you wish to execute the command:
|The command to execute. Note that you can use either the full command name or its abbreviation.|
A set of global options specifying the product URL and means of authentication. These may be used for all commands
|A set of options corresponding to the command|
|A set of arguments corresponding to the command|
JFrog CLI makes use of the following environment variables:
This variable determines the log level of the JFrog CLI.
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
Defines the JFrog CLI home directory.
[Default: The operating system's temp directory]
Defines the temp directory used by JFrog CLI.
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.
Determines a URL to an HTTP proxy.
Determines a URL to an HTTPS 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.
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.
plugins=(git mvn npm sdk jfrog)
To install auto-completion for bash, run the following command and follow the instructions to complete the installation.
To install auto-completion for zsh, run the following command and follow the instructions to complete the installation.
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
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:
- 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 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 release notes are available on Bintray.