CLI for JFrog Xray

JFrog CLI

ft:sourceType: Ftml

JFrog CLI
JFrog CLI
About JFrog CLI
General
Advanced upload and download capabilities
Support for popular package managers and build tools
Binaries and dependencies scanning
Support for Build-Info
Contributing to JFrog CLI Documentation
Read More
JFrog CLI v2
Overview
List of changes in JFrog CLI v2
Download and installation
General
JFrog CLI v2 "jf" installers
JFrog CLI v2 "jfrog" installers
JFrog CLI v1 (legacy) installers
System Requirements
Usage
Environment Variables
JFrog Platform Configuration
Web Login to the JFrog Platform
Adding and Editing Configured Servers
Removing Configured Servers
Showing the Configured Servers
Setting a Server as Default
Exporting and Importing Configuration
Export
Import
Setting up a CI Pipeline
Proxy Support
Shell Auto-Completion
Install JFrog CLI with Homebrew?
Using Oh My Zsh?
Sensitive Data Encryption
JFrog CLI Plugins
General
Installing Plugins
Private Plugins Registries
Release Notes
CLI for JFrog Artifactory
JFrog CLI : CLI for JFrog Artifactory
Overview
Environment Variables
Authentication
Authenticating with Username and Password / API Key
Authenticating with an Access Token
Authenticating with RSA Keys
Authenticating using Client Certificates (mTLS)
Storing Symlinks in Artifactory
Using Placeholders
Examples
Example 1: Upload all files to the target repository
Example 2: Upload all files sharing the same prefix to the target repository
Example 3: Upload all files to corresponding directories according to extension type
Example 4: Copy all zip files to target repository and append with an extension.
General Commands
Verifying Artifactory is Accessible
Examples
Example 1
Example 2
Example 3
Uploading Files
Examples
Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
Example 7
Downloading Files
Examples
Example 1
Example 2
Example 3
Example 4
Copying Files
Examples
Example 1
Example 2
Example 3
Moving Files
Examples
Example 1
Example 2
Example 3
Deleting Files
Examples
Example 1
Example 2
Searching Files
Examples
Example 1
Example 2
Example 3
Setting Properties on Files
Example
Example 1
Example 2
Deleting Properties from Files
Example
Creating Access Tokens
Examples
Cleaning Up Unreferenced Files from a Git LFS Repository
Examples
Example 1
Example 2
Running cUrl
Examples
Example 1
Example 2
Build Integration
Overview
Collecting Build-Info
Collecting Dependencies
Collecting Build Artifacts
Collecting Environment Variables
Example
Collecting Information from Git
Example
Configuration file properties
Adding Files as Build Dependencies
Example
Publishing Build-Info
Example
Aggregating Published Builds
Requirements
Example
Promoting a Build
Example
Cleaning up the Build
Discarding Old Builds from Artifactory
Example
Package Managers Integration
Running Maven Builds
Setting maven repositories
Running maven
Examples
Running Gradle Builds
Setting gradle repositories
Running gradle
Examples
Running Builds with MSBuild
Managing Docker Images
Examples
Pulling Docker Images Using the Docker Client
Examples
Pushing Docker Images Using the Docker Client
Examples
Pulling Docker Images Using Podman
Examples
Pushing Docker Images Using Podman
Examples
Pushing Docker Images Using Kaniko
Pushing Docker Images Using buildx
Pushing Docker Images Using the OpenShift CLI
Adding Published Docker Images to the Build-Info
Examples
Promoting Docker Images
Examples
Building Npm Packages Using the Npm Client
Requirements
Setting npm repositories
Installing Npm Packages
Examples
Example 1
Example 2
Example 3
Publishing the Npm Packages into Artifactory
Example
Building Npm Packages Using the Yarn Client
Setting npm repositories
Installing Npm Packages
Examples
Example 1
Building Go Packages
General
Requirements
Example project
Setting Go repositories
Examples
Example 1
Example 2
Running Go commands
Examples
Example 1
Example 2
Publishing Go Packages to Artifactory
Examples
Example 1
Example 2
Building Python Packages
Example projects
Setting Python repository
Examples
Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
Installing Python packages
Examples
Building NuGet Packages
Setting NuGet repositories
Running Nuget and Dotnet commands
Examples
Example 1
Example 2
Example 3
Packaging and Publishing Terraform Modules
Examples
Example 1
Example 2
Examples
Example 1
Example 2
Example 3
Managing Configuration Entities
Creating Users
Example
Deleting Users
Example 1
Example 2
Creating Groups
Example
Adding Users to Groups
Example
Deleting Groups
Example
Managing Repositories
Creating or Configuration Template
Example
Creating / Updating Repositories
Example 1
Example 2
Example 3
Deleting Repositories
Example
Managing Replications
Creating a Configuration Template
Example
Creating Replication Jobs
Example 1
Example 2
Deleting Replication jobs
Example
Managing Permission Targets
Creating a Configuration Template
Creating / Updating Permission Targets
Deleting Permission Targets
Using File Specs
File Spec Schemas
Copy and Move Commands Spec Schema
Download Command Spec Schema
Create and Update Release Bundle Commands Spec Schema
Upload Command Spec Schema
Search, Set-Props and Delete Commands Spec Schema
Examples
Example 1:
Example 2:
Example 3:
Example 4: Upload
Example 5:
Example 6:
Example 7:
Example 8:
Example 9:
Example 10:
Example 11:
Example 12
Example 13
Example 14
Schema Validation
Using Jetbrains IDEs (Intellij IDEA, Webstorm, Goland, etc...)?
Using Visual Studio Code?
Downloading the Maven and Gradle Extractor JARs
Transferring Files Between Artifactory Servers
Overview
Limitations
Before You Begin
Running the Transfer Process
Step 1 - Set Up the Source Instance for Files Transfer
Step 2 - Push the Files from the Source to the Target Instance
Installing the data-transfer User Plugin on the Source Machine Manually
Installing JFrog CLI on the Source Instance Machine
How Does Files Transfer Work?
Files Transfer Phases
Files Transfer State
Installing JFrog CLI on a Machine with Network Access to the Source and Target Machines
Controlling the File Transfer Speed
Routing the Traffic from the Source to the Target Through an HTTPS Proxy
CLI for JFrog Distribution
JFrog CLI: CLI for JFrog Distribution
Overview
Syntax
Managing Access Keys
Commands
Creating or updating an unsigned Release Bundle
Examples
Example 1
Example 2
Example 3
Example 4
Example 5
Example 6
Signing an Existing Release Bundle
Examples
Example 1
Distributing a Release Bundle
Examples
Example 1
Deleting a Release Bundle
Examples
Example 1
Example 2
CLI for JFrog Mission Control
JFrog CLI : CLI for JFrog Mission Control
Overview
Syntax
Commands
Adding a JPD
Config JSON schema
Deleting a JPD
Acquiring a License
Example 1
Deploying a License
Releasing a License
CLI for JFrog Xray
JFrog CLI : CLI for JFrog Xray
Overview
Authentication
Authenticating with Username and Password
Authenticating with an Access Token
Scanning Project Dependencies
General
Advanced Scans
Output Example
Examples
Running cUrl
Examples
On-Demand Binary Scan
Scanning Files on the Local File System
Scanning Docker Containers on the Local File System
Scanning Image Tarballs on the Local File System
Docker Client
Use Docker client ‘docker save’ command to save the image to the file system for scanning.
Skopeo
Podman
Kaniko
Scanning Published Builds
Example
Downloading updates for Xray's database
CLI for JFrog Pipelines
Overview
Syntax
Commands
Checking Pipelines Version
Example
Getting Run Status
Triggering a Pipeline
CLI-for-JFrog-Pipelines
Syncing Pipeline Source
Sync Status of Pipeline Source
CLI for JFrog Release Lifecycle Management
JFrog CLI: CLI for JFrog Release Lifecycle Management
Overview
Commands
Creating a Release Bundle v2 from builds or from existing Release Bundles
Examples
Example 1
Example 2
Example 3
Promoting a Release Bundle v2
Examples
Example 1
Example 2
Transfer Artifactory Configuration and Files from Self-Hosted to JFrog Cloud
Transfer Artifactory Configuration and Files from Self-Hosted to JFrog Cloud
General
Artifactory Version Support
Transfer phases
Limitations
Before you begin
Running the transfer process
Step 1: Enabling configuration transfer on the target instance
Step 2: Set up the source instance for pushing files to the target instance
Step 3: Transfer configuration from the source instance to the target instance
Step 4: Disabling configuration transfer on the target instance
Step 5: Push the files from the source to the target instance
Step 6: Sync the configuration between the source and the target
Transferring projects and repositories from multiple source instances
How does files transfer work?
Files transfer phases
Using Replication
Files transfer state
Installing JFrog CLI on a machine with network access to the source and target machines
Installing JFrog CLI on the source instance machine
Controlling the file transfer speed
Build-info repositories
Manually copying the filestore to reduce the transfer time
Running pre-checks before initiating the files transfer process
Transferring files larger than 25 GB
Routing the traffic from the source to the target through an HTTPS proxy
Frequently asked questions
CLI for JFrog Curation
JFrog CLI : CLI for JFrog Curation
Overview
Commands
Output Example

Back to home page