Skip to end of metadata
Go to start of metadata

Overview

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

Read more about JFrog CLI here.

Syntax

$ 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.
global-options

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.

Use the config command

To avoid having to set these for every command, you may set them once using the config command 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


Page Contents



Commands

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

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

Configuration

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
Command options


--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.

clearClears the stored configuration.


Examples

Example 1

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

$ jfrog mc c
Example 2

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

$ jfrog mc c --url=http://<mission-control-domain> --access-token=access-token-value
Example 3

Show, and then clear the configuration details.

$ 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.

Command options
The command accepts no options, other than the global options.

Config JSON schema


{
  "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

jfrog mc 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.


Command options
The command accepts no options, other than the global options.

Example

jfrog mc 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

Bucket 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.


Command options
The command accepts no options, other than the global options.

Examples

Example 1

Assign a license from the my-bucket-id and mark it as taken by my-unique-name.

jfrog mc 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

Bucket ID

Bucket name or identifier to deploy licenses from.

JPD ID

An existing JPD's ID.


Command options

--license-count

[Default: 1]

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

Example

Deploy a single license from my-bucket-id on my-jpd-id.

jfrog mc 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

Bucket 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.


Command options
The command accepts no options, other than the global options.

Example

Releases all licenses of my-jpd-id to to my-bucket-id.

jfrog mc lr my-bucket-id my-jpd-id
  • No labels