JFrog CLI

Need help with other JFrog products?

JFrog Platform
JFrog Artifactory
JFrog Xray
JFrog Mission Control
JFrog分布
[JFrog Pipelines]
JFrog Access

Expand all Collapse all
Page tree

Versions Compared

Old Version21

changes.mady.by.userEyal Ben Moshe

Saved on

compared with

New VersionCurrent

changes.mady.by.userEyal Ben Moshe

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This page describes how to use JFrog CLI with JFrog Mission Control.

Read more about JFrog CLIhere.

Syntax

Code Block 
$ jfrog mc command-name arguments global-options command-options

Where:

command-name
 The command to execute. Note that you can use either the full command name or its abbreviation.
全局选项

A set of global options that may be used for all commands:

--url:(Optional) Mission Control URL.

--access-token:(Optional) Mission Control admin access token.

Tip
title Use the config command

To avoid having to set these for every command, you may set them once using theconfigcommand and then omit them for every following command.
command-options
 A set of options corresponding to the command
arguments
 A set of arguments corresponding to the command


Info
icon false
title Page Contents

Table of Contents
maxLevel 4
minLevel 2


Commands

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

Tip

We strongly recommend running theconfigcommand right after installing the JFrog CLI to avoid having to pass in the Mission Control URL and login credentials for every command.

配置

This command is used to configure the JFrog CLI with the default Mission Control URL and access token, which should be used in the other commands so that you don't have to pass them in each time. These values are defaults for each command can be overridden per command by passing in alternative values for the Mission Control URL and access token. The values configured are saved in~/.jfrog/jfrog-cli.conf.

Command name
config
Abbreviation
c
命令选择ions
--url [Optional] The Mission Control URL to be used for the other commands. --access-token [Optional] The access-token to be used for the other commands.
Command arguments
If no arguments are passed in, the command will configure the Mission Control URL and access token through the command options or through the interactive prompt show

Shows the stored configuration.

clear Clears the stored configuration.

Examples

Example 1

Configure the Mission Control URL and access token using the interactive prompt.

Code Block 
$ jfrog mc c
Example 2

Configure the Mission Control URL and access token by passing them in as command options.

Code Block 
$ jfrog mc c --url=http:// --access-token=access-token-value
Example 3

Show, and then clear the configuration details.

Code Block 
$ jfrog mc c show $ jfrog mc c clear

Adding a JPD

Command name
 jpd-add
Abbreviation
 ja
Description
 Adds a JPD to Mission Control
Command arguments

Config

Path to a JSON configuration file containing the JPD details.
命令选择ions
 The command accepts no options, other than the global options.

Config JSON schema

Code Block 
{ "name" : "jpd-0", "url" : "http://jpd:8080/test", "token" : "some-token", "location" : { "city_name" : "San Francisco", "country_code" : "US", "latitude" : 37.7749, "longitude" : 122.4194 }, "tags" : [ "tag0", "tag1" ] }


Example

Code Block 
jfrogjfmc ja path/to/jpd/config.json

Deleting a JPD

Command name
 jpd-delete
Abbreviation
 jd
Description

Delete a JPD from Mission Control.
Command arguments

JPD ID

The ID of the JPD to be removed from Mission Control.

命令选择ions
 The command accepts no options, other than the global options.

Example

Code Block 
jfrogjfmc jd my-jpd-id

Acquiring a License

Command name

license-acquire
Abbreviation
 la
Description

Acquire a license from the specified bucket and mark it as taken by the provided name.
Command arguments

桶ID

Bucket name or identifier to acquire license from.

Name

A custom name used to mark the license as taken. Can be a JPD ID or a temporary name. If the license does not end up being used by a JPD, this is the name that should be used to release the license.

命令选择ions
 The command accepts no options, other than the global options.

Examples

Example 1

Assign a license from themy-bucket-idand mark it as taken bymy-unique-name.

Code Block 
jfrogjfmc la my-bucket-id my-unique-name

Deploying a License

Command name

license-deploy
Abbreviation
 ld
Description

pecified bucket to an existing JPD. You may also deploy a number of licenses to an Artifactory HA.
Command arguments
桶ID

Bucket name or identifier to deploy licenses from.
JPD ID

An existing JPD's ID.

命令选择ions

--license-count

[Default: 1]

The number of licenses to deploy. Minimum value is 1.

Example

Deploy a single license frommy-bucket-idonmy-jpd-id.

Code Block 
jfrogjfmc ld my-bucket-id my-jpd-id

Releasing a License

Command name

license-release
Abbreviation
 lr
Description

Release all licenses of a JPD and return them to the specified bucket.
Command arguments
桶ID

Bucket name or identifier to release all of its licenses.
JPD ID

If the license is used by a JPD, pass the JPD's ID. If the license was only acquired but is not used, pass the name it was acquired with.

命令选择ions
 The command accepts no options, other than the global options.

Example

Releases all licenses ofmy-jpd-idto tomy-bucket-id.

Code Block 
jfrogjfmc lr my-bucket-id my-jpd-id