JFrog CLI Cheat Sheet
Configure Client
jfrog config show
jfrog config add <env name>
jfrog config use <env name>
Test configuration with
jfrog rt ping # Should return "OK"
Builds
jfrog rt podman-push <tag> --build-name=<name> --build-number=<number>
jfrog rt bp <name> <number> # Create build
jfrog rt bs <name> <number> # Scan build with XRay
jfrog rt s --build <name> # Show latest build by name
Managing Artifacts
To copy from one repo to another:
jfrog rt cp --flat <src repo>/<name>/<version> <target repo>/<name>/<version>
Note the --flat true which is required to avoid getting a <target repo>/<name>/<name> structure when the target already exists and you actually want to overwrite.
Other commands:
jfrog rt u <file> <target repo> # Upload
jfrog rt d <repo>/<path> # Download
jfrog rt mv <repo>/<path> <repo> # Move
List Docker tags
jfrog rt cl /api/docker/<repo>/v2/<name>/tags/list
API Queries
jfrog rt cl <API path> # Run curl commands using stored credentials
jfrog rt cl /api/build # List builds
jfrog rt cl /api/build/<name> # Get build runs
jfrog rt cl /api/build/<name>/<id> # Get build run info
jfrog rt cl /api/storage/<path> # File listing
jfrog rt cl /api/compliance/<path> # Compliance details
API Search Queries
Quick Search
# Any artifact in a folder
jfrog rt cl /api/search/artifact?name=<file name>&repos=<repo name>
# Maven artifact
jfrog rt cl /api/search/gavc?g=<group>&a=<artifact>&v=<version>&c=<classifier>&repos=<repo>
# Pattern search
jfrog rt cl /api/search/pattern?pattern=<repo>:<ant pattern>
jfrog rt cl /api/search/pattern?pattern=libs-release-local:killer/*/ninja/*/*.jar
# Reverse dependency lookup
jfrog rt cl /api/search/dependency?sha1=<checksum>
# Get list of repos
jfrog rt cl /api/repositories
AQL Searches
Easiest way is to do via file.
jfrog rt s --spec=file.aql
Note when using spec files the AQL query needs to be wrapped as shown in the next example.
Second easiest way is to use an in-place file:
jfrog rt s --spec=<(echo '{"files":[{"aql":{"items.find":{"name":{"$match": "cicd-base-image*"}}}}]}')
AQL searches can be performed via API as POST request against /api/search/aql. For example with curl:
curl "<server>/api/search/aql" \
-H "Content-Type: text/plain" \
-d 'items.find({ "repo":{"$eq":"libs-release-local"} })'
jfrog AQL Examples
Alternatively to quick search you can perform complex queries using AQL
AQL for searching artifacts
// Find packages by name matching
items.find({"name":{"$match":"mypackage-*"}})
// Find packages by type
items.find({"type":{"$eq":"conan"}})
// Find by property
items.find({"@property": {"$eq" : "value"}})
items.find({"@artifactory.licenses":"*"})
// Find everything by time
items.find({"created" : {"$gte":"2020-01-01"}})
items.find({"modified": {"$gte":"2020-01-01"}})
AQL for searching repos
// Find repo by name
items.find({"repo":{"$eq":"libs-release-local"}})
// Implicit AND condition by listing multiple criteria
items.find({"repo":{"$eq":"my-repo"}, "name":{"$match": "*.deb"}})
items.find({"repo":{"$eq":"my-repo"}, "path":{"$match":"*/subfolder"}})
items.find({"repo":{"$eq":"my-repo"}, "path":{"$match":"*/subfolder"}, "name":{"$match": "*.deb"}})
// Sort and limit
items.find({"name":{"$match": "release-nr-*"}}).sort({"$desc":["created"]}).limit(1)
AQL for searching builds
// Return all artifacts of the "artifactory" build.
items.find({"@build.name":{"$eq":"artifactory"}})
// Return all builds that have a dependency with a license that is not Apache.
builds.find({"module.dependency.item.@license":{"$nmatch":"Apache-*"}})
AQL for archive searches
// Return all archives containing a file called "org/artifactory/Main.class".
items.find({"archive.entry.name":{"$eq":"Main.class"} , "archive.entry.path":{"$eq":"org/artifactory"}})
AQL Filtering / Pagination
// Pagination
items.find(...).limit(100)
items.find(...).offset(100).limit(50)
Advanced
// Negativ matching
items.find({"name":{"$nmatch":"<pattern>"}})
// List all properties
items.find(...).include("repo", "name", "path", "properties.*")