Need help with other JFrog products?
JFrog Enterprise+
JFrog Artifactory
JFrog Xray
JFrog Mission Control
JFrog Distribution
[JFrog Pipelines]
JFrog Bintray
JFrog Access
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:
|
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_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 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. |
--apikey | [Optional] Artifactory API key. |
| --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.
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
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 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
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
JFrog CLI release notes are available here.
Overview
Content Tools