Quick Start

Step 1: Install

Install JFrog CLI via cURL:

curl -fL https://install-cli.jfrog.io | sh

Verify the installation:

jf --version

If this step fails: If jf --version returns "command not found", the binary is not in your PATH. Try /usr/local/bin/jf --version. If that works, add it to your PATH: export PATH=$PATH:/usr/local/bin. For other installation methods, see Download and Install JFrog CLI.

Step 2: Authenticate

Add a server configuration with your access token:

jf config add <server-id> --url=<your-url> --access-token=<your-token> --interactive=false

Replace <server-id>, <your-url>, and <your-token> with your values. For example:

jf config add my-server --url=https://acme.jfrog.io --access-token=eyJ... --interactive=false

If this step fails: If you see "Server ID already exists", add --overwrite to the command. If you see a connection error, verify your URL includes https:// and is reachable with curl -I <your-url>/api/system/ping. If you don't have an access token yet, generate one in the UI: Administration > Identity and Access > Access Tokens.

Step 3: Verify the Connection

Ping Artifactory to confirm authentication works:

jf rt ping --server-id=<server-id>

You should see OK when the connection is valid.

If this step fails: A 401 error means invalid credentials — regenerate your access token. A connection timeout means the URL is wrong or unreachable — verify with curl -I <your-url>. A TLS error means certificate issues.

Step 4: View Environment Variables

Inspect all supported environment variables:

jf options

Use this output to set JFROG_URL, JFROG_ACCESS_TOKEN, and other variables for scripted use.

Step 5: Clean Up

Remove the test server configuration:

jf config remove <server-id> --quiet

Expected Output

When everything works correctly, your session looks something like this:

$ jf --version
jf version 2.x.x

$ jf config add my-server --url=https://acme.jfrog.io --access-token=eyJ... --interactive=false
Server configuration successfully added.

$ jf rt ping --server-id=my-server
OK

$ jf options
JFROG_CLI_LOG_LEVEL             Log verbosity. DEBUG, INFO, WARN or ERROR
JFROG_CLI_LOG_TIMESTAMP         Timestamp format for log messages...
... (full list of environment variables)

$ jf config remove my-server --quiet

Troubleshooting