Get Started with JFrog CLI

JFrog CLI is a compact and smart client that provides a simple interface to automate access to JFrog products, simplifies your automation scripts and making them more readable and easier to maintain.

JFrog CLI works with JFrog Artifactory, JFrog Xray, JFrog Distribution, and JFrog Mission Control.(through their respective REST APIs), making your scripts more efficient and reliable in several ways.

Download the JFrog CLI binary for your operating system and install it locally.
After installation, verify that the CLI is available in your terminal. Click here to download and install JFrog CLI

JFrog CLI Documentation by Product Area

These sections provide deeper guidance on using JFrog CLI with specific JFrog products and platform capabilities.

Binary Management (Artifactory)

Use JFrog CLI to upload, download, promote, and manage binaries and packages with Artifactory.

Security (Xray)

Scan dependencies, binaries, and containers for vulnerabilities and license compliance issues.

Governance & Lifecycle

Automate promotion, distribution, and lifecycle policies using JFrog CLI.

Integrations

Integrate JFrog CLI with CI/CD tools, package managers, and cloud platforms.

Platform Administration

Manage users, permissions, system settings, and platform operations.

Advanced Upload and Download Capabilities

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 parts to split files for parallel download using the --split-count option.

To optimize both uploads and downloads, JFrog CLI avoids transferring artifacts that already exist in the target location. Before uploading, the CLI checks the artifact's checksum with Artifactory. If the artifact is already present in Artifactory's storage, the CLI skips the upload, and Artifactory may just update its database to reflect the new upload. Similarly, when downloading an artifact, if it already exists in the specified download path, it will be skipped. This checksum optimization also allows you to pause long upload and download operations and resume them later from where you left off.

JFrog CLI simplifies file uploads by supporting wildcard patterns, regular expressions, and ANT patterns, allowing you to easily select all the files you want to upload. You can also use wildcard patterns for downloading files.

Support for popular package managers and build tools

JFrog CLI offers comprehensive support for popular package managers and build tools. It seamlessly integrates with package managers like npm, Maven, Gradle, NuGet, Docker, Go, pip, Pipenv, Poetry, Yarn, Helm, Terraform, Conan, and more, allowing you to easily manage and publish packages.

Source code and binaries scanning

JFrog CLI empowers you with robust scanning capabilities to ensure the security and compliance of your source code and software artifacts, including containers. It integrates with JFrog Xray, enabling you to scan and analyze your projects and packages, including containers, for vulnerabilities, license compliance, and quality issues. With JFrog CLI, you can proactively identify and mitigate potential risks, ensuring the integrity and safety of your software supply chain.

Support for Build-Info

Build-Info is a comprehensive metadata Software Bill of Materials (SBOM) that captures detailed information about the components used in a build. It serves as a vital source of information, containing version history, artifacts, project modules, dependencies, and other crucial data collected during the build process. By storing this metadata in Artifactory, developers gain traceability and analysis capabilities to improve the quality and security of their builds. The Build-Info encompasses project module details, artifacts, dependencies, environment variables, and more. It is collected and outputted in a JSON format, facilitating easy access to information about the build and its components. JFrog CLI can create a Build-Info and store the Build-Info in Artifactory.

System Requirements

JFrog CLI runs on any modern operating system including Windows, macOS, and Linux. Pre-compiled binaries are available for direct download, eliminating the need for users to install any dependencies. Go is only required if building the CLI from source.

Contributing to JFrog CLI

Your input is valuable in making the JFrog CLI better. You can help enhance and improve it by recommending changes and additions. To contribute, follow these steps:

Go to the JFrog CLI project on GitHub: GitHub - jfrog/jfrog-cli and create a pull request with your proposed changes and additions. Please read the contribution guidelines before submitting.

Your contributions will be reviewed, and if accepted, they will be merged into the project to benefit the entire JFrog CLI community.