jf
Execute commands from JSON/YAML files
TLDR
Add a new configuration
Show the current configuration
Search for artifacts within the given repository and directory
SYNOPSIS
jf [global-options] <command> [command-options] <arguments>
For example: jf rt upload [options]
Or: jf config add
PARAMETERS
--version
Displays the client version of the JFrog CLI.
--help
Shows a help message for the command or subcommand.
-h
Short alias for --help, shows a help message for the command or subcommand.
--config
Specifies a named configuration to use, bypassing the default or configured server.
--url
Sets the JFrog Platform URL for the current command execution, overriding configured values.
--user
Specifies the username for authentication with the JFrog Platform for the current command.
--password
Provides the password for authentication with the JFrog Platform for the current command.
--apikey
Authenticates using an API key instead of username/password for the current command.
--access-token
Authenticates using an access token (Pat/Bearer Token) for the current command.
--server-id
Uses the credentials configured for a specific server ID for the current command.
--log-level
Sets the logging level (e.g., DEBUG, INFO, WARN, ERROR) for output.
--format
Specifies the output format for command results (e.g., JSON, TABLE, NONE).
--insecure-tls
Allows insecure TLS connections without certificate verification.
--no-progress
Disables the progress bar for file transfers and other operations.
--quiet
Suppresses most log output, showing only critical information.
-q
Short alias for --quiet, suppresses most log output.
DESCRIPTION
The jf command, commonly an alias for the JFrog CLI, is a powerful and versatile command-line interface designed to interact with the entire JFrog Platform. It provides a unified way to manage artifacts, builds, security scans, distribution, and other operations across JFrog products such as Artifactory, Xray, and Distribution. Built in Go, it offers a seamless integration with CI/CD pipelines, automating common tasks like uploading and downloading artifacts, managing build information, triggering security scans, and configuring platform settings. Its modular design allows users to interact with specific JFrog services through dedicated subcommands, making it an essential tool for developers and DevOps engineers working with binary management and software supply chain automation.
CAVEATS
The jf command is not a standard Linux utility and must be installed separately. It functions primarily as a client for the JFrog Platform, requiring access to JFrog Artifactory, Xray, or other JFrog services to be fully functional. Its behavior is highly dependent on the configured JFrog server and the specific subcommands used.
SUBCOMMANDS OVERVIEW
The jf command operates primarily through a rich set of subcommands, each designed to interact with a specific JFrog product or perform a particular task. Key subcommands include:
rt (for Artifactory operations),
xr (for Xray security scans),
ds (for Distribution operations),
bt (for build tools integration),
config (for managing JFrog platform connections),
plugin (for managing CLI plugins), and
completion (for shell command completion). Each subcommand has its own set of specific options and arguments.
INSTALLATION
The JFrog CLI can be installed by downloading the executable binary directly from the JFrog website, or via various package managers like Homebrew (macOS), scoop (Windows), apt (Debian/Ubuntu), or yum (RHEL/CentOS). Users often create a shell alias (e.g., alias jf=jfrog) for convenience.
CONFIGURATION
Before using most jf commands, it's necessary to configure connection details to your JFrog Platform instance. This is typically done using the jf config add command, which prompts for the JFrog URL, credentials, and an optional server ID. This configuration is then saved for future use.
HISTORY
The JFrog CLI, often aliased as jf, originated as jfrog-cli-go, reflecting its implementation in the Go programming language. It was developed by JFrog to provide a consistent and powerful command-line interface for its suite of products, including Artifactory, Xray, and Distribution. Over time, it has evolved to become a universal CLI, integrating deeply with CI/CD pipelines and offering extensive automation capabilities for software supply chain management.