JFrog CLI

JFrog CLI v2

Overview

我们最近发布的JFrog CLI v2,包括udes 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

1. The default value of the--flatoption is now set to false for thejfrogrt uploadcommand.
2. The deprecated syntax of thejfrogrt mvncommand is no longer supported. To use the new syntax, the project needs to be first configured using thejfrogrt mvnccommand.
3. The deprecated syntax of thejfrogrt gradlecommand is no longer supported. To use the new syntax, the project needs to be first configured using thejfrogrt gradleccommand.
4. The deprecated syntax of thejfrogrt npmandjfrogrt npm-cicommands is no longer supported. To use the new syntax, the project needs to be first configured using thejfrogrt npmccommand.
5. The deprecated syntax of thejfrogrt gocommand is no longer supported. To use the new syntax, the project needs to be first configured using thejfrogrt go-configcommand.
6. The deprecated syntax of thejfrogrt nugetcommand is no longer supported. To use the new syntax, the project needs to be first configured using thejfrogrt nugetccommand.
7. All Bintray commands are removed.
8. Thejfrogrt configcommand is removed and replaced by thejfrogconfig addcommand.
9. Thejfrogrt usecommand is removed and replaced with thejfrogconfig use.
10. The--propscommand option andpropsfile spec property for thejfrogrt uploadcommand are removed, and replaced with the--target-propscommand option andtargetPropsfile spec property respectively.

11. The following commands are removed

    jfrogrt release-bundle-create jfrog rt release-bundle-delete jfrog rt release-bundle-distribute jfrog rt release-bundle-sign jfrog rt release-bundle-update

    andreplaced 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

12. Thejfrogrt go-publishcommand 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 thejfrogrt go-configcommand.
13. Thejfrogrt gocommand no longer falls back to the VCS when dependencies are not found in Artifactory.
14. The--deps,--publish-deps,--no-registryand--selfoptions of thejfrogrt go-publishcommand are now removed.
15. The--apiKeyoption is now removed. The API key should now be passed as the value of the--passwordoption.
16. The--exclude-patternsoption is now removed, and replaced with the--exclusionsoption. The same is true for theexcludePatternsfile spec property, which is replaced with the除外责任property.
17. TheJFROG_CLI_JCENTER_REMOTE_SERVERandJFROG_CLI_JCENTER_REMOTE_REPOenvironment variables are now removed and replaced with theJFROG_CLI_EXTRACTORS_REMOTEenvironment variable.
18. TheJFROG_CLI_HOMEenvironment variable is now removed and replaced with theJFROG_CLI_HOME_DIRenvironment variable.
19. TheJFROG_CLI_OFFER_CONFIGenvironment variable is now removed and replaced with theCIenvironment variable. Setting CI to true disables all prompts.
20. The directory structure is now changed when thejfrogrt downloadcommand is used with placeholders and --flat=false(--flat=false is now the default). When placeholders are used, the value of the--flatoption is ignored.
21. When thejfrogrt uploadcommand now uploads symlinks to Atyifctory, the target file referenced by the symlink is uploaded to Artifactory with the symlink name. If the--symlinkoptions 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

General

下载可执行文件,请访问JFrog CLI Download Site.

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

The legacy name of JFrog CLI's executable isjfrog. In an effort to make the CLI usage easier and more convenient, we recently exposed a series of new installers, which install JFrog CLI with the newjfexecutable name. For backward compatibility, the old installers will remain available. We recommend however migrating to the newerjfexecutable name.

JFrog CLI v2 "jf" installers

The following installers are available for JFrog CLI v2. These installers make JFrog CLI available through thejfexecutable.

wget -qO - https://releases.jfrog.io/artifactory/jfrog-gpg-public/jfrog_public_gpg.key | sudo apt-key add - echo "deb https://releases.jfrog.io/artifactory/jfrog-debs xenial contrib" | sudo tee -a /etc/apt/sources.list; apt update; apt install -y jfrog-cli-v2-jf;

echo "[jfrog-cli]" > jfrog-cli.repo; echo "name=jfrog-cli" >> jfrog-cli.repo; echo "baseurl=https://releases.jfrog.io/artifactory/jfrog-rpms" >> jfrog-cli.repo; echo "enabled=1" >> jfrog-cli.repo; rpm --import https://releases.jfrog.io/artifactory/jfrog-gpg-public/jfrog_public_gpg.key sudo mv jfrog-cli.repo /etc/yum.repos.d/; yum install -y jfrog-cli-v2-jf;

brew install jfrog-cli

curl -fL https://install-cli.jfrog.io | sh

curl -fL https://getcli.jfrog.io/v2-jf | sh

npm install -g jfrog-cli-v2-jf

Slim: docker run releases-docker.jfrog.io/jfrog/jfrog-cli-v2-jf jf -v Full: docker run releases-docker.jfrog.io/jfrog/jfrog-cli-full-v2-jf jf -v

powershell "Start-Process -Wait -Verb RunAs powershell '-NoProfile iwr https://releases.jfrog.io/artifactory/jfrog-cli/v2-jf/[RELEASE]/jfrog-cli-windows-amd64/jf.exe -OutFile $env:SYSTEMROOT\system32\jf.exe'"

choco install jfrog-cli-v2-jf

JFrog CLI v2 "jfrog" installers

The following installers are available for JFrog CLI v2. These installers make JFrog CLI available through thejfrogexecutable.

wget -qO - https://releases.jfrog.io/artifactory/jfrog-gpg-public/jfrog_public_gpg.key | sudo apt-key add - echo "deb https://releases.jfrog.io/artifactory/jfrog-debs xenial contrib" | sudo tee -a /etc/apt/sources.list; apt update; apt install -y jfrog-cli-v2;

echo "[jfrog-cli]" > jfrog-cli.repo; echo "name=jfrog-cli" >> jfrog-cli.repo; echo "baseurl=https://releases.jfrog.io/artifactory/jfrog-rpms" >> jfrog-cli.repo; echo "enabled=1" >> jfrog-cli.repo; rpm --import https://releases.jfrog.io/artifactory/jfrog-gpg-public/jfrog_public_gpg.key sudo mv jfrog-cli.repo /etc/yum.repos.d/; yum install -y jfrog-cli-v2;

brew install jfrog-cli

curl -fL https://getcli.jfrog.io/v2 | sh

npm install -g jfrog-cli-v2

Slim: docker run releases-docker.jfrog.io/jfrog/jfrog-cli-v2 jfrog -v Full: docker run releases-docker.jfrog.io/jfrog/jfrog-cli-full-v2 jfrog -v

choco install jfrog-cli

JFrog CLI v1 (legacy) installers

The following installations are available for JFrog CLI v1. These installers make JFrog CLI available through thejfrogexecutable.

wget -qO - https://releases.jfrog.io/artifactory/jfrog-gpg-public/jfrog_public_gpg.key | sudo apt-key add - echo "deb https://releases.jfrog.io/artifactory/jfrog-debs xenial contrib" | sudo tee -a /etc/apt/sources.list; apt update; apt install -y jfrog-cli;

echo "[jfrog-cli]" > jfrog-cli.repo; echo "name=jfrog-cli" >> jfrog-cli.repo; echo "baseurl=https://releases.jfrog.io/artifactory/jfrog-rpms" >> jfrog-cli.repo; echo "enabled=1" >> jfrog-cli.repo; rpm --import https://releases.jfrog.io/artifactory/jfrog-gpg-public/jfrog_public_gpg.key sudo mv jfrog-cli.repo /etc/yum.repos.d/; yum install -y jfrog-cli;

curl -fL https://getcli.jfrog.io | sh

npm install -g jfrog-cli-go

Slim: docker run releases-docker.jfrog.io/jfrog/jfrog-cli jfrog -v Full: docker run releases-docker.jfrog.io/jfrog/jfrog-cli-full jfrog -v

GO111MODULE=on go get github.com/jfrog/jfrog-cli; if [ -z "$GOPATH" ] then binPath="$HOME/go/bin"; else binPath="$GOPATH/bin"; fi; mv "$binPath/jfrog-cli" "$binPath/jfrog"; echo "$($binPath/jfrog -v) is installed at $binPath";

System Requirements

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

Usage

To use the CLI,installit on your local machine, ordownloadits executable,place it anywhere in your file system and add its location to your路径environment variable.

Environment Variables

Thejf optionscommand displays all the supported environment variables.

JFrog CLI makes use of the following environment variables:

JFrog Platform Configuration

Adding and Editing Configured Servers

Theconfig addandconfig editcommands 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.

Removing Configured Servers

Theconfig removecommand is used to remove JFrog Platform server configuration, stored in JFrog CLI's configuration storage.

Showing the Configured Servers

Theconfig showcommand shows the stored configuration. You may show a specific server's configuration by sending its ID as an argument to the command.

Setting a Server as Default

Theconfig usecommand sets a configured server as default. The following commands will use this server.

Exporting and Importing Configuration

Theconfig exportcommand generates a token, which stores the server configuration. This token can be used by theconfig importcommand, to import the configuration stored in the token, and save it in JFrog CLI's configuration storage.

Export

Import

Setting up a CI Pipeline

Theci-setupcommand 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:

jf 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.

Shell Auto-Completion

If you're using JFrog CLI from a bash, zsh, or fish shells, you can install JFrog CLI's auto-completion scripts.

To install auto-completion forbash, run the following command and follow the instructions to complete the installation:

jf completion bash --install

To install auto-completion forzsh, run the following command and follow the instructions to complete the installation:

jf completion zsh --install

To install auto-completion forfish, run the following command:

jf completion fish --install

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 examplef84hc22dQfhe9f8ydFwfsdn48!wejh8A

• Create a file namedsecurity.yamlunder~/.jfrog/security.

  If you modified the default JFrog CLI home directory by setting JFROG_CLI_HOME_DIR environment variable, then thesecurity/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: ""

• 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.

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 inJFrog 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 theJFrog CLI Plugins Developer Guideif you wish to create and publish your own plugins.

Installing Plugins

A plugin which is includedJFrog CLI's Plugins Registrycan be installed using the following command.

$ jf 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 thePrivate Plugins Registriessection.

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 namedjfrog-cli-plugins.
• Make sure your Artifactory server is included in JFrog CLI's configuration, by running thejf c showcommand.
• If needed, configure your Artifactory instance using thejfrogc addcommand.
• 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.

Thejf plugin installcommand 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.

jf plugin publish the-plugin-name the-plugin-version

Release Notes

Release notesforJFrog CLI v2

Release notesfor the legacy releases of JFrog CLI