Managing Configuration Entities

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

Creating Users

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

"username","password","email"
"username1","password1","john@c.com"
"username2","password1","alice@c.com"

Note: The first line in the CSV is cells' headers. It is mandatory and is used by the command to map the cell value to the users' details.

The CSV can include additional columns, with different headers, which will be ignored by the command.

Commands Params

Creating Users Example

Create new users according to details defined in the path/to/users.csv file.

jf rt users-create --csv path/to/users.csv

Deleting Users

This command allows deleting a bulk of users. The command a list of usernames to delete. The list can be either provided as a comma-seperated argument, or as a CSV file, which includes one column with the usernames. Here's the CSV format.

"username"
"username1"
"username2"
"username2"

The first line in the CSV is cells' headers. It is mandatory and is used by the command to map the cell value to the users' details.

The CSV can include additional columns, with different headers, which will be ignored by the command.

Commands Params

Deleting Users Examples

Deleting Users Example 1

Delete the users according to the usernames defined in the path/to/users.csv file.

jf rt users-delete --csv path/to/users.csv

Deleting Users Example 2

Delete the users according to the u1, u2 and u3 usernames.

jf rt users-delete "u1,u2,u3"

Creating Groups

This command creates a new users group.

Commands Params

Creating Groups Example

Create a new group name reviewers.

jf rt group-create reviewers

Adding Users to Groups

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

Commands Params

Adding Users to Groups Example

Add to group reviewers the users with the following usernames: u1, u2 and u3.

jf rt group-add-users "reviewers" "u1,u2,u3"

Deleting Groups

This command deletes a group.

Commands Params

Deleting Groups Example

Delete the reviewers group.

jf rt group-delete "reviewers"

Managing Repositories

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:

 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:

 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:

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

Optional Repository Configurations

For additional optional configurations to fine-tune the repository's behavior, configure the following:

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", # example variable, ${repo-name}
  "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"

Creating / Updating 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

Creating / Updating 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"

Creating Hugging Face Repositories

JFrog CLI supports creating Hugging Face repositories using the repo-create command with a JSON template file. This enables you to set up local repositories for proprietary ML models and remote repositories for caching public models from Hugging Face Hub.

Important: Single Hugging Face repository creation is not currently supported via CLI. You can only create Hugging Face repositories using a multi-repository template file containing an array of repository configurations.

Multi-Repository Creation (Supported)

To create multiple Hugging Face repositories in a single operation:

Step 1: Create a template file (hf-repos.json):

[
  {
    "key": "${HF_LOCAL}",
    "rclass": "local",
    "packageType": "huggingface",
    "description": "Local repository for internal ML models"
  },
  {
    "key": "${HF_REMOTE}",
    "rclass": "remote",
    "packageType": "huggingface",
    "url": "https://huggingface.co",
    "description": "Remote repository caching Hugging Face Hub"
  }
]

Step 2: Execute the command with variable substitution:

jf rt repo-create hf-repos.json --vars "HF_LOCAL=my-hf-local;HF_REMOTE=my-hf-remote"

Supported Repository Classes for Hugging Face

Limitations

Deleting Repositories

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

Commands Params

Deleting Repositories Example

Delete a repository from Artifactory.

jf rt repo-delete generic-local

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

Creating 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

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

Creating 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

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

Deleting Replication Jobs

This command permanently deletes a replication jobs from a repository.

Commands Params

Delete a Repository Example

Delete a repository from Artifactory.

jf rt rpldel my-repo-name

Managing 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 which create and update the permission targets 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 permission target. The configuration template file is created using the jf rt permission-target-template command.

Creating a Configuration Template

This command creates a configuration template file, which will be used as an argument for the jf rt permission-target-create and jf rt permission-target-update commands.

Commands Params

Creating / Updating Permission Targets

These commands create/update a permission target. The commands accept as an argument a configuration template, which should be created by the jf rt permission-target-template command beforehand. The template also supports variables, which can be replaced with values, provided when it is used.

Deleting Permission Targets

This command permanently deletes a permission target.