JFrog CLI

Need help with other JFrog products?

JFrog Platform
JFrog Artifactory
JFrog Xray
JFrog Mission Control
JFrog Distribution
[JFrog Pipelines]
JFrog Access

Expand all   Collapse all
Page tree
Skip to end of metadata
Go to start of metadata

Overview

This page describes how to use JFrog CLI with JFrog Pipelines.

Read more about JFrog CLI here.

JFrog Pipelines CLI is available with JFrog CLI 2.34 and above.

Before using JFrog Pipelines CLI, configure access token using the --access-token as described in this section.


Syntax

$ jf pl command-name arguments command-options

Where:

command-name
The command to execute. Note that you can use either the full command name or its abbreviation.
command-options
A set of options corresponding to the command
arguments
A set of arguments corresponding to the command

Page Contents


Commands

The following sections describe the commands available in the JFrog CLI for use with JFrog Pipelines.

Checking Pipelines Version 

Check the version of Pipelines installation.

Command name
pl version
Abbreviation
v
Command arguments
The command accepts no arguments.
Command options

--server-id

[Optional]

Specify Pipelines server for which the version is to be fetched. If not specified, the default configured server is used.

Example

jf pl version --server-id repo21

Getting Run Status

Get the status of the run for the specified pipeline.

Command name
pl status
Abbreviation
s
Command arguments
The command accepts no arguments.

Command options

--pipeline-name

[Optional]

Name of the pipeline.

--branch

[Optional]

Name of the multi branch.

--monitor

[Optional]

Continuous monitoring until pipeline reaches end state.

Default time is 1 hour and 30 minutes.

--server-id

[Optional]

Name of the server.

--single-branch

[Optional]

To be used when using a single branch.

Examples

Single Branch
jf pl status --pipeline-name myPipeline --single-branch --server-id repo21 --monitor --single-branch
Multi Branch
jf pl status --pipeline-name myPipeline --branch main/jobs --server-id repo21 --monitor

Triggering a Pipeline

Trigger a pipeline run.

Command name

pl trigger

Abbreviation
t
Command options

--server-id

[Optional]

Name of the server.

--single-branch

[Optional]

To be used when using a single branch. When used, branch_name argument is ignored.

Command arguments

pipeline_name

Name of the pipeline to be triggered.

branch_name

Name of the multi branch.

Examples

Single Branch
jf pl trigger myPipeline main/jobs --single-branch --server-id repo21
Multi Branch
jf pl trigger myPipeline main/jobs --server-id repo21

Syncing Pipeline Source

Perform a sync to load the latest pipeline source.

Command name

pl sync

Abbreviation
sy
Command options

--server-id

[Optional]

Name of the server.

--repository

[Optional]

Full name of the repository where the pipeline source is stored.

--branch

[Optional]

Name of branch that has the pipeline source.

Example

jf pl sync --repository jfrog/artifactory --branch main/jobs --server-id repo21

Sync Status of Pipeline Source

Get the current status of the pipeline source sync.

Command name

pl sync-status

Abbreviation
ss
Command options

--server-id

[Optional]

Name of the server.

Command arguments

full_repo_name

Full name of the repository where the pipeline source is stored.

branch_name

Name of the branch.

Example

jf pl sync-status jfrog/artifactory main/jobs --server-id repo21

  • No labels

JFrog.com | Documentation | Featured | Have a question? Want to report an issue? Contact JFrog support