Environment Variables
To use the CLI, install it on your local machine, or download its executable, place it anywhere in your file system, and add its location to your PATH environment variable.
The jf options command displays all the supported environment variables. The following table lists the available variables.
Environment Variables Reference
| Variable Name | Description |
|---|---|
JFROG_CLI_LOG_LEVEL | [Default: INFO] Determines the log level of the JFrog CLI. Possible values are: DEBUG, INFO, WARN, and ERROR. If set to ERROR, JFrog CLI logs error messages only. It is useful when you wish to read or parse the JFrog CLI output and do not want any other information logged. |
JFROG_CLI_LOG_TIMESTAMP | [Default: TIME] Controls the log messages timestamp format. Possible values are: TIME, DATE_AND_TIME, and OFF. |
JFROG_CLI_HOME_DIR | [Default: ~/.jfrog] Defines the JFrog CLI home directory path. |
JFROG_CLI_TEMP_DIR | [Default: The operating system's temp directory] Defines the temp directory used by JFrog CLI. |
JFROG_CLI_BUILD_NAME | Build name to be used by commands which expect a build name, unless sent as a command argument or option. |
JFROG_CLI_BUILD_NUMBER | Build number to be used by commands which expect a build number, unless sent as a command argument or option. |
JFROG_CLI_BUILD_PROJECT | Artifactory project key. |
JFROG_CLI_SERVER_ID | Server ID configured using the config command. |
CI | [Default: false] If true, disables interactive prompts and progress bar. |
JFROG_CLI_PLUGINS_SERVER | [Default: Official JFrog CLI Plugins registry] Configured Artifactory server ID from which to download JFrog CLI Plugins. |
JFROG_CLI_PLUGINS_REPO | [Default: 'jfrog-cli-plugins'] Can be optionally used with the JFROG_CLI_PLUGINS_SERVER environment variable. Determines the name of the local repository to use. |
JFROG_CLI_TRANSITIVE_DOWNLOAD | [Default: false] Set this option to true to include remote repositories in artifact searches when using the 'rt download' command. The search will target the first five remote repositories within the virtual repository. This feature is available starting from Artifactory version 7.17.0. Note: Enabling this option may increase the load on Artifactory instances that are proxied by multiple remote repositories. |
JFROG_CLI_RELEASES_REPO | Configured Artifactory repository name from which to download the jar needed by the mvn/gradle command. The value format should be <server ID configured by the 'jf c add' command>/<repo name>. The repository should proxy https://releases.jfrog.io. This environment variable is used by the 'jf mvn' and 'jf gradle' commands, and also by the 'jf audit' command when used for maven or gradle projects. |
JFROG_CLI_DEPENDENCIES_DIR | [Default: $JFROG_CLI_HOME_DIR/dependencies] Defines the directory to which JFrog CLI's internal dependencies are downloaded. Supported by the following commands: maven and gradle. |
JFROG_CLI_MIN_CHECKSUM_DEPLOY_SIZE_KB | [Default: 10] Minimum file size in KB for which JFrog CLI performs checksum deploy optimization. Supported by the upload command. |
JFROG_CLI_UPLOAD_EMPTY_ARCHIVE | [Default: false] Set to true to upload an empty archive when '--archive' is set but all files were excluded by exclusion patterns. Supported by the upload command. |
JFROG_CLI_BUILD_URL | Sets the CI server build URL in the build-info. The 'jf rt build-publish' command uses the value of this environment variable, unless the --build-url command option is sent. |
JFROG_CLI_ENV_EXCLUDE | [Default: password;psw;secret;key;token;auth] List of case-insensitive semicolon-separated patterns in the form of "value1;value2;...". Environment variables matching those patterns will be excluded. This environment variable is used by the 'jf rt build-publish' command, in case the --env-exclude command option is not sent. |
JFROG_CLI_FAIL_NO_OP | [Default: false] Set to true if you want the command to return exit code 2 when no files are affected. Supported by the following commands: copy, delete, delete-props, set-props, download, move, search, and upload. |
JFROG_CLI_ENCRYPTION_KEY | If provided, encrypts the sensitive data stored in the config with the provided key. Must be exactly 32 characters. |
JFROG_CLI_AVOID_NEW_VERSION_WARNING | [Default: false] Set to true to avoid checking the latest available JFrog CLI version and printing a warning when a newer version exists. |
JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR | Defines the directory path where the command summaries data is stored. Every command will have its own individual directory within this base directory. |
JFROG_CLI_ANALYZER_MANAGER_VERSION | Specifies the version of Analyzer Manager to be used for security commands, provided in semantic versioning format (e.g., 1.13.4). By default, the latest stable version is used. |
JFROG_CLI_GITHUB_TOKEN | [Default: None] Specifies the GitHub token to be used for CLI version check on the GitHub repository. |
JFROG_CLI_HIDE_SURVEY | [Default: false] Set to true to hide the survey link that appears after successful command execution. |
Examples
Log and Debug
# Enable debug logging for troubleshooting
export JFROG_CLI_LOG_LEVEL=DEBUG
# Include timestamps with date for audit trails
export JFROG_CLI_LOG_TIMESTAMP=DATE_AND_TIME
# Suppress all non-error output for parsing CLI output
export JFROG_CLI_LOG_LEVEL=ERRORConfigure CI/CD Pipelines
# Disable interactive prompts in automated environments
export CI=true
# Set build information
export JFROG_CLI_BUILD_NAME="my-project"
export JFROG_CLI_BUILD_NUMBER="${BUILD_NUMBER}"
export JFROG_CLI_BUILD_URL="${BUILD_URL}"
# Associate with Artifactory project
export JFROG_CLI_BUILD_PROJECT="myproject"
# Suppress version warnings in CI
export JFROG_CLI_AVOID_NEW_VERSION_WARNING=true
# Hide survey prompts
export JFROG_CLI_HIDE_SURVEY=trueApply Security Best Practices
# Exclude sensitive environment variables from build-info
export JFROG_CLI_ENV_EXCLUDE="*password*;*secret*;*key*;*token*;*auth*;*credential*"
# Encrypt configuration with a 32-character key
export JFROG_CLI_ENCRYPTION_KEY="your-32-character-encryption-key"Configure Custom Paths
# Use custom home directory
export JFROG_CLI_HOME_DIR="/opt/jfrog-cli"
# Use custom temp directory
export JFROG_CLI_TEMP_DIR="/tmp/jfrog-cli"
# Store dependencies in custom location
export JFROG_CLI_DEPENDENCIES_DIR="/opt/jfrog-cli/deps"Maven and Gradle Configuration
# Configure releases repository for Maven/Gradle
# Format: <server-id>/<repository-name>
export JFROG_CLI_RELEASES_REPO="my-server/jfrog-releases"Optimize Uploads and Downloads
# Enable transitive download from remote repositories
export JFROG_CLI_TRANSITIVE_DOWNLOAD=true
# Adjust checksum deploy threshold (in KB)
export JFROG_CLI_MIN_CHECKSUM_DEPLOY_SIZE_KB=50
# Return exit code 2 when no files are affected
export JFROG_CLI_FAIL_NO_OP=true
- Always consider security best practices when handling sensitive information, particularly when using environment variables in CI/CD pipelines.
- Environment variables set in your shell session will override default values.
- For persistent configuration, add these exports to your shell profile (e.g.,
~/.bashrc,~/.zshrc).- Use the
jf optionscommand to see all supported environment variables and their current values.
Discovering Environment Variables
Use jf options to display all supported environment variables and their current values at runtime:
jf optionsThis command shows every variable, its default value, and a brief description — useful for discovering variables you didn't know existed.
Environment Variable Categories
For easier reference, the variables above fall into these categories:
| Category | Variables |
|---|---|
| Logging | JFROG_CLI_LOG_LEVEL, JFROG_CLI_LOG_TIMESTAMP |
| Build Information | JFROG_CLI_BUILD_NAME, JFROG_CLI_BUILD_NUMBER, JFROG_CLI_BUILD_PROJECT, JFROG_CLI_BUILD_URL, JFROG_CLI_ENV_EXCLUDE |
| Server Configuration | JFROG_CLI_SERVER_ID, JFROG_CLI_HOME_DIR, JFROG_CLI_TEMP_DIR, JFROG_CLI_ENCRYPTION_KEY |
| Plugin Configuration | JFROG_CLI_PLUGINS_SERVER, JFROG_CLI_PLUGINS_REPO |
| Behavior Modifiers | CI, JFROG_CLI_FAIL_NO_OP, JFROG_CLI_TRANSITIVE_DOWNLOAD, JFROG_CLI_AVOID_NEW_VERSION_WARNING, JFROG_CLI_HIDE_SURVEY, JFROG_CLI_UPLOAD_EMPTY_ARCHIVE |
| CI/CD Integration | JFROG_CLI_COMMAND_SUMMARY_OUTPUT_DIR, JFROG_CLI_GITHUB_TOKEN |
| Build Tool Dependencies | JFROG_CLI_RELEASES_REPO, JFROG_CLI_DEPENDENCIES_DIR, JFROG_CLI_MIN_CHECKSUM_DEPLOY_SIZE_KB |
| Security | JFROG_CLI_ANALYZER_MANAGER_VERSION |
Glossary
| Term | Definition |
|---|---|
| Artifactory | JFrog's universal binary repository manager that stores, manages, and distributes software packages |
| Build-info | A JSON record that captures everything about a build: dependencies resolved, artifacts produced, environment variables, and source code details |
| JPD | JFrog Platform Deployment — a single instance of the JFrog Platform containing Artifactory, Xray, and other services |
| OIDC | OpenID Connect — an identity protocol used for token-based authentication in CI/CD pipelines |
| Xray | JFrog's security scanning service that analyzes artifacts for vulnerabilities and license compliance |
| Distribution | JFrog's service for distributing release bundles to edge nodes |
| Mission Control | JFrog's service for managing multiple JPD instances, licenses, and platform deployments |
| File Spec | A JSON file that defines patterns and properties for bulk file operations (upload, download, search) |
| Build-info | Metadata capturing dependencies, artifacts, environment variables, and Git information for a build |
| Access Token | A JWT-format credential issued by the JFrog Platform for authenticating CLI and API requests |
Updated 7 days ago
