JFrog CLI environment variables

The JFrog CLI reads standard shell environment variables to control logging, build metadata, server selection, encryption, and other behavior. This reference lists each variable and how it affects the CLI. If you are new to the CLI, install it (or download the binary), place it on your PATH, then return here to tune runtime options.

The jf options command displays all supported environment variables with their default values and descriptions. The following table lists the available variables.

Environment Variables Reference

Examples

This topic covers:

• Log and debug CLI output
• Configure CI/CD pipelines
• Apply security best practices for build-info
• Encrypt the CLI configuration
• Configure custom paths
• Maven and Gradle-related variables
• Optimize uploads and downloads

Log and Debug

To enable debug logging:

• Run:

  Bash

  export JFROG_CLI_LOG_LEVEL=DEBUG

To include timestamps with date for audit trails:

• Run:

  Bash

  export JFROG_CLI_LOG_TIMESTAMP=DATE_AND_TIME

To suppress all non-error output when parsing CLI output:

• Run:

  Bash

  export JFROG_CLI_LOG_LEVEL=ERROR

Configure CI/CD Pipelines

To disable interactive prompts in automated environments:

• Run:

  Bash

  export CI=true

To set build information for published build-info (${BUILD_NUMBER} and ${BUILD_URL} are provided by your CI system; outside CI, substitute literals or omit):

1. Run:

   Bash

   export JFROG_CLI_BUILD_NAME="<build-name>"
   export JFROG_CLI_BUILD_NUMBER="${BUILD_NUMBER}"
   export JFROG_CLI_BUILD_URL="${BUILD_URL}"

   Where:

   • <build-name>: Logical name for the build.

   For example:

   Bash

   export JFROG_CLI_BUILD_NAME="my-project"
   export JFROG_CLI_BUILD_NUMBER="${BUILD_NUMBER}"
   export JFROG_CLI_BUILD_URL="${BUILD_URL}"

2. To associate the build with an Artifactory project, run:

   Bash

   export JFROG_CLI_BUILD_PROJECT="<project-key>"

   Where:

   • <project-key>: Artifactory project key.

   For example:

   Bash

   export JFROG_CLI_BUILD_PROJECT="myproject"

3. To suppress version warnings and survey prompts in CI, run:

   Bash

   export JFROG_CLI_AVOID_NEW_VERSION_WARNING=true
   export JFROG_CLI_HIDE_SURVEY=true

Apply Security Best Practices

To extend the default exclusion patterns for sensitive environment variables in build-info:

• Run:

  Bash

  export JFROG_CLI_ENV_EXCLUDE="<pattern-list>"

  Where:

  • <pattern-list>: Semicolon-separated case-insensitive patterns. The default already includes *psw*; extend rather than replace if you need extra coverage.

  For example:

  Bash

  export JFROG_CLI_ENV_EXCLUDE="*password*;*psw*;*secret*;*key*;*token*;*auth*;*credential*"

Encrypting the CLI Configuration

🚧

JFROG_CLI_ENCRYPTION_KEY must be set before running jf config add for the first time. Setting this variable on an already-configured CLI will cause jf config show to fail with cipher: message authentication failed and all existing server configurations will be lost. If you have an existing configuration, remove it first and then reconfigure with the key set.

To encrypt your CLI configuration from scratch:

1. Remove any existing configuration:

   Bash

   jf config rm --quiet

2. Set the encryption key. The value must be exactly 32 characters.

   Bash

   export JFROG_CLI_ENCRYPTION_KEY="<encryption-key>"

   Where:

   • <encryption-key>: A stable 32-character secret. Store it securely; loss of the key means you must reconfigure.

3. Add your server so the configuration is stored encrypted. See jf config add for flags; a minimal interactive add is:

   Bash

   jf config add

Configure Custom Paths

To use a custom JFrog CLI home directory (choose a user-writable path; /opt/... often requires elevated permissions):

• Run:

  Bash

  export JFROG_CLI_HOME_DIR="$HOME/.jfrog-custom"

To use a custom temp directory:

• Run:

  Bash

  export JFROG_CLI_TEMP_DIR="/tmp/jfrog-cli"

To store internal dependencies in a custom location:

• Run:

  Bash

  export JFROG_CLI_DEPENDENCIES_DIR="$HOME/.jfrog-custom/deps"

Maven and Gradle Configuration

To point Maven/Gradle commands at an internal releases repository (format <server-id>/<repository-name>):

• Run:

  Bash

  export JFROG_CLI_RELEASES_REPO="<server-id>/<repository-name>"

  Where:

  • <server-id>: Server ID from jf config add.
  • <repository-name>: Repository key that proxies JFrog releases if applicable.

  For example:

  Bash

  export JFROG_CLI_RELEASES_REPO="my-server/jfrog-releases"

Optimize Uploads and Downloads

To include remote repositories in artifact searches for jf rt download:

• Run:

  Bash

  export JFROG_CLI_TRANSITIVE_DOWNLOAD=true

To change the minimum file size (KB) for checksum deploy optimization:

• Run:

  Bash

  export JFROG_CLI_MIN_CHECKSUM_DEPLOY_SIZE_KB=50

To return exit code 2 when no files are affected (supported commands include copy, delete, delete-props, set-props, download, move, search, and upload):

• Run:

  Bash

  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 (for example, ~/.bashrc, ~/.zshrc).
• The jf options command lists supported environment variables, defaults, and descriptions. The env | grep JFROG_CLI command shows values currently active in your shell.

Discovering Environment Variables

The jf options command lists every supported environment variable together with its default value and description:

jf options

That output reflects built-in defaults, not necessarily the values exported in your current shell. To inspect the values active in the current session:

• Run:

  Bash

  env | grep JFROG_CLI

Environment Variable Categories

For easier reference, the variables above fall into these categories:

Glossary