Repository Management

JFrog CLI offers a set of commands for managing Artifactory repositories. You can create, update and delete repositories. To make it easier to manage repositories, the commands which create and update the repositories accept a pre-defined configuration template file. This template file can also include variables, which can be later replaced with values, when creating or updating the repositories. The configuration template file is created using the jf rt repo-template command.

Creating Repository Configuration Template

The jf rt repo-template (or jf rt rpt) command provides interactive prompts for building a JSON configuration template.

On running jf rt repo-template <filename>.json, the CLI prompts as follows:

Template Type

Select the template type. Following are the possible options:

• create: Template for creating a new repository
• update: Template for updating an existing repository

Select the template type (press Tab for options):

For example:

Select the template type (press Tab for options): create

Repository Key

Enter a unique identifier for the repository key. This is the key field in the final JSON.

Insert the repository key >

For example:

Insert the repository key > npm-local

Note

If you want to reuse the template for creating multiple repositories, use a variable as follows:

Insert the repository key > ${repo-key-var}

Repository Class

Select the repository class. Following are the possible options:

• local: A physical, locally-managed repository into which you can deploy artifacts.
• remote: A caching proxy for a repository managed at a remote URL. For remote repositories you need to enter a remote repository URL.
• virtual: An aggregation of several repositories with the same package type under a common URL.
• federated: A Federation is a collection of Federated repositories in different JPDs that are automatically configured for full bi-directional mirroring.

Select the repository class (press Tab for options):

For example:

Select the repository class (press Tab for options): local

Repository Package Type

Select the repository package type. Following are the possible options:

• alpine
• bower
• cargo
• chef
• cocoapods
• composer
• conan
• cran
• debian
• docker
• gems
• generic
• gitlfs
• go
• gradle
• helm
• ivy
• maven
• npm
• nuget
• opkg
• pypi
• puppet
• rpm
• sbt
• swift
• terraform
• vagrant
• yum

Note

After selecting the repository package type, you can exit by entering :x or proceed to make advanced configurations.

Optional Repository Configurations

This table explains the optional keys available for configuring your desired repository in JFrog Artifactory.

After adding your desired configurations, enter :x to save the template file. Creates and saves a json template and exits the interactive terminal.

The sample json template is as follows:

{
  "description": "my npm local repository",
  "key": "my-npm-local",
  "packageType": "npm",
  "rclass": "local"
}

Reuse Template with Variables

Reuse the template by adding variables to the keys and provide value explicitly while executing the jf rt repo-create command.

For example:

jf rt repo-create repotemplate.json --vars "repo-name=my-npm-local"

If you want to pass multiple vars, enter the list of semicolon-separated(;) variables in the form of "key1=value1;key2=value2;..." (wrapped by quotes) to be replaced in the template. In the template, the variables should be used as follows: ${key1}.

jf rt repo-create repotemplate.json --vars "repo-name=my-npm-local;package-type=npm;repo-type=local"

Create / Update Repositories

These two commands create a new repository and updates an existing a repository. Both commands accept as an argument a configuration template, which can be created by the jf rt repo-template command. The template also supports variables, which can be replaced with values, provided when it is used.

Commands Params

Create / Update Repositories Examples

Create a Repository Example

Create a repository, using the template.json file previously generated by the repo-template command.

jf rt repo-create template.json

Update a Repository Example 1

Update a repository, using the template.json file previously generated by the repo-template command.

jf rt repo-update template.json

Update a Repository Example 2

Update a repository, using the template.json file previously generated by the repo-template command. Replace the repo-name variable inside the template with a name for the updated repository.

jf rt repo-update template.json --vars "repo-name=my-repo"

Delete Repositories

This command permanently deletes a repository, including all of its content.

Commands Params

Delete Repositories Example

Delete a repository from Artifactory.

jf rt repo-delete generic-local

Manage Replications

JFrog CLI offers commands creating and deleting replication jobs in Artifactory. To make it easier to create replication jobs, the commands which creates the replication job accepts a pre-defined configuration template file. This template file can also include variables, which can be later replaced with values, when creating the replication job. The configuration template file is created using the jf rt replication-template command.

Create a Configuration Template

This command creates a configuration template file, which will be used as an argument for the jf rt replication-create command.

When using this command to create the template, you can also provide replaceable variable, instead of fixes values. Then, when the template is used to create replication jobs, values can be provided to replace the variables in the template.

Commands Params

Manage Replications Example

Create a configuration template, with two variables for the source and target repositories. Then, create a replication job using this template, and provide source and target repository names to replace the variables.

$ jf rt rplt template.json
Select replication job type (press Tab for options): push
Enter source repo key > ${source}
Enter target repo key > ${target}
Enter target server id (press Tab for options): my-server-id
Enter cron expression for frequency (for example: 0 0 12 * * ? will replicate daily) > 0 0 12 * * ?
You can type ":x" at any time to save and exit.
Select the next property > :x
[Info] Replication creation config template successfully created at template.json.
$
$ jf rt rplc template.json --vars "source=generic-local;target=generic-local"
[Info] Done creating replication job.

Create Replication Jobs

This command creates a new replication job for a repository. The command accepts as an argument a configuration template, which can be created by the jf rt replication-template command. The template also supports variables, which can be replaced with values, provided when it is used.

Commands Params

Create Replication Jobs Examples

Create a Replication Job Example 1

Create a replication job, using the template.json file previously generated by the replication-template command.

jf rt rplc template.json

Update a Replication Job Example

Update a replication job, using the template.json file previously generated by the replication-template command. Replace the source and target variables inside the template with the names of the replication source and target repositories.

jf rt rplc template.json --vars "source=my-source-repo;target=my-target-repo"

Delete Replication Jobs

This command permanently deletes a replication jobs from a repository.

Commands Params

Delete Replication Jobs Example

Delete a replication job from a repository.

jf rt rpldel my-repo-name

JFrog CLI offers a set of commands for managing Artifactory configuration entities.

When to Use These Commands

Create Users

This command allows creating a bulk of users. The details of the users are provided in a CSV format file.

For full CSV format, options, and examples, see jf rt users-create.

Delete Users

This command allows deleting a bulk of users. The command accepts a list of usernames to delete, either as a comma-separated argument or as a CSV file.

For full options and examples, see jf rt users-delete.

Create Groups

This command creates a new users group.

For full options and examples, see jf rt group-create.

Add Users to Groups

This command adds a list of existing users to a group.

For full options and examples, see jf rt group-add-users.

Delete Groups

This command deletes a group.

For full options and examples, see jf rt group-delete.

Manage Permission Targets

JFrog CLI offers commands creating, updating and deleting permission targets in Artifactory. To make it easier to create and update permission targets, the commands accept a pre-defined configuration template file.

For the full command reference for permission target management, see the individual command pages:

• jf rt permission-target-template — Create a JSON configuration template interactively
• jf rt permission-target-update — Create or update a permission target from a template
• jf rt permission-target-delete — Permanently delete a permission target