LinuxCommandLibrary

jfrog

Manage and deploy artifacts using JFrog Artifactory

TLDR

View documentation for the original command

$ tldr jf
copy

SYNOPSIS

jfrog [global options] <command> [command options/arguments]

Examples of common top-level commands include:
* jfrog rt <subcommand> (for Artifactory operations)
* jfrog xr <subcommand> (for Xray operations)
* jfrog ds <subcommand> (for Distribution operations)
* jfrog config <subcommand> (for CLI configuration)
* jfrog --version
* jfrog --help

PARAMETERS

--version
    Displays the JFrog CLI version.

--help / -h
    Provides help information for the jfrog command or its subcommands.

--url <JFROG_PLATFORM_URL>
    Specifies the JFrog Platform URL, overriding any configured value.

--user <USERNAME>
    Specifies the username for authentication, overriding any configured value.

--password <PASSWORD>
    Specifies the password for authentication, overriding any configured value. (Not recommended for automation; use access tokens)

--access-token <TOKEN>
    Specifies the access token for authentication, overriding any configured value. (Recommended for automation)

--interactive / -i
    Runs the command in interactive mode, guiding the user through configuration or input.

--log-level <LEVEL>
    Sets the logging verbosity level (e.g., DEBUG, INFO, WARN, ERROR).

--config <FILE_PATH>
    Specifies the path to a custom CLI configuration file.

--skip-update-check
    Skips the check for JFrog CLI updates on execution.

DESCRIPTION

The JFrog CLI is a compact and smart client that provides a single interface to automate and simplify your CI/CD pipelines. It interacts seamlessly with JFrog products like Artifactory, Xray, and Distribution, offering functionalities such as artifact management, security scanning, and distribution control. It's designed for developers and DevOps engineers to script and manage their software development lifecycle efficiently. Key features include intelligent artifact uploading and downloading, build integration, dependency management, and security scanning capabilities. The CLI optimizes network transfers, handles metadata, and ensures data integrity, making it an essential tool for robust and repeatable software delivery processes.

CAVEATS

Authentication: Ensure correct JFrog Platform URL, username/password, or access token are configured or provided, especially in CI/CD environments. Access tokens are generally preferred for automation.
Version Compatibility: Always check the JFrog CLI documentation for compatibility with your JFrog Platform and product versions to avoid unexpected behavior.
Network Connectivity: The CLI requires stable network connectivity to the JFrog Platform. Proxies might need to be configured.
Permissions: The user authenticated with the CLI must have the necessary permissions on the JFrog platform to perform the requested operations.

CONFIGURATION MANAGEMENT

The jfrog config command group is essential for managing CLI configurations. It allows you to add, edit, or remove JFrog Platform instances, set default parameters, and manage access tokens. This ensures that the CLI can securely and efficiently interact with your JFrog instances without requiring repeated manual input of credentials for every command.

BUILD INTEGRATION

One of the key strengths of JFrog CLI is its deep integration with popular build tools like Maven, Gradle, npm, Docker, and others. It can automatically collect build information, dependencies, and artifacts, then publish this data to Artifactory. This "build info" is crucial for traceability, reproducibility, and enabling Xray security scans, providing a comprehensive view of your software supply chain.

HISTORY

The JFrog CLI evolved as the primary command-line tool for interacting with the JFrog Platform. Initially, specific tools or direct API calls were used, but the CLI was developed to unify and simplify operations across different JFrog products (Artifactory, Xray, Distribution, etc.). Its continuous development focuses on improving performance, adding support for new features in the JFrog Platform, and enhancing user experience, especially for automation in CI/CD pipelines. It provides advanced features like checksum deployment, build info collection, and dependency resolution, making it a cornerstone for DevOps automation with JFrog products.

SEE ALSO

curl(1), wget(1), git(1), mvn(1), npm(1), docker(1)

Copied to clipboard