JFrog CLI documentation has moved. You can view it at is new location here.

The JFrog Applications content has moved to a new location. You can view that content in its new location here.

Installation instructions for CLI documentation has moved. You can view it at is new location .

Instructions for authenticating via the CLI has moved. You can view it at its new location here.

Documentation on JFrog CLI's auto-completion scripts has moved. You can view it at its new location here.

Documentation on CLI configuration has moved. You can view it in its new location here.

Information about working configuring JFrog Platform CLI has moved. You can view it in its new location here.

Documentation on proxy support for the JFrog CLI has moved. You can view it in its new location here.

Documentation on managing binaries in JFrog via the CLI has moved. You can view it in its new location here.

Documentation on Artifactory environment variables has moved. You can view it in its new location here.

Information on options for authenticating via the JFrog CLI has moved. You can view it in its new location here.

Instructions on verifying Artifactory's accessibility via the CLI have moved. You can view it in its new location here.

Information regarding options for performing complex operations via CLI using the -spec option have moved. You can view them in their new location here.

Documentation regarding integrating build management with JFrog CLI has moved. You can view it in its new location here.

Documentation regarding integrating the JFrog CLI with various package managers has moved. You can view it in its new location here.

Documentation managing Artifactory configuration entities via the JFrog CLI has moved. You can view it in its new location here.

Documentation on using JFrog CLI with Release Lifecycle Management has moved. You can view it in its new location here.

Documentation on cleaning up files from a Git LFS repository has moved. You can view it at its new location here.

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

Documentation on the JFrog CLI for Distribution has moved. You can view it at its new location here.

Documentation on migrating from a self-hosted to cloud deploying using the CLI has moved. You can view it in its new location here.

Documentation on the JFrog command for initializing a new JFrog worker has moved. You can view it at its new location here.

Documentation for using the JFrog CLI to test-run a Worker has moved. You can see it at its new location here.

Documentation on using the JFrog CLI to edit a worker and add or edit a secret has moved. You can view it at its new location here.

Documentation on how to display the execution history of a specific worker has moved. You can view it at its new location here.

Documentation on how to edit the Worker schedule via the JFrog CLI has moved. You can view it at its new location here.

Documentation on JFrog CLI plugins has moved. You can view it at its new location here.

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on using JFrog CLI with JFrog Platform Services has moved. You can view it at its new location .

Documentation on how to list all the available events via the JFrog CLI has moved. You can view it at its new location .

Documentation on how to list workers saved on your Artifactory instance has moved. You can view it at its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on uploading and managing files via the JFrog CLI have moved. You can view it at its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on creating and attaching evidence via the JFrog CLI has moved. You can view it in its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on using the cURL command with Artifactory, and its related parameters has moved. You can view it in its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on using placeholders with the JFrog CLI has moved. You can view it in its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on using the JFrog CLI to undeploy a worker has moved. You can view it at its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on transferring files stored in one Artifactory instance to another has moved. You can view it in its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on how to execute an HTTP-triggered worker via the JFrog CLI has moved. You can view the content in its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

Documentation on the command summaries feature for recording JFrog CLI command outputs has moved. You can view it at its new location .

Documentation on JFrog CLI environment variables for installation has moved. You can view it at its new location .

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it , including sections on:

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

Documentation about uploading and downloading symlinks (soft links) between your local file system and Artifactory has moved. You can view it in its new location here.

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

Documentation on using the JFrog CLI to deploy a JFrog worker has moved. You can view it at its new location here.

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it here, including sections on:

• CLI

• Frogbot

• IDEs

The JFrog Security documentation has a new home! You can now find it , including sections on:

Overview

JFrog CLI Plugins allow enhancing the functionality of JFrog CLI to meet the specific user and organization needs. The source code of a plugin is maintained as an open source Go project on GitHub. All public plugins are registered in JFrog CLI's Plugins Registry. We encourage you, as developers, to create plugins and share them publicly with the rest of the community. When a plugin is included in the registry, it becomes publicly available and can be installed using JFrog CLI. Version 1.41.1 or above is required. Plugins can be installed using the following JFrog CLI command:

This article guides you through the process of creating and publishing your own JFrog CLI Plugin.

Creating your first plugin

Prepare your development machine

• Make sure Go 1.17 or above is installed on your local machine and is included in your system PATH.

• Make sure git is installed on your local machine and is included in your system PATH.

Build and run your first plugin

1. Go to .

2. Press the Use this template button to create a new repository. You may name it as you like.

3. Clone your new repository to your local machine. For example:

1. Run the following commands, to build and run the template plugin.

1. Open the plugin code with your favorite IDE and start having fun.

What can plugins do?

Well, plugins can do almost anything. The sky is the limit.

1. You have access to most of the JFrog CLI code base. This is because your plugin code depends on the module. It is a dependency declared in your project's go.mod file. Feel free to explore the jfrog-cli-core code base, and use it as part of your plugin.

2. You can also add other Go packages to your go.mod and use them in your code.

3. You can package any external resources, such as executables or configuration files, and have them published alongside your plugin. Read more about this

Including plugins in the official registry

General

To make a new plugin available for anyone to use, you need to register the plugin in the JFrog CLI Plugins Registry. The registry is hosted in . The registry includes a descriptor file in YAML format for each registered plugin, inside the plugins directory. To include your plugin in the registry, create a pull request to add the plugin descriptor file for your plugin according to this file name format: your-plugin-name.yml.

Guidelines for developing and publishing plugins

To publish your plugin, you need to include it in . Please make sure your plugin meets the following guidelines before publishing it.

• Read the document. You'll be asked to accept it before your plugin becomes available.

• Code structure. Make sure the plugin code is structured similarly to the . Specifically, it should include a commands package, and a separate file for each command.

• Tests. The plugin code should include a series of thorough tests. Use the as a reference on how the tests should be included as part of the source code. The tests should be executed using the following Go command while inside the root directory of the plugin project. Note: The Registry verifies the plugin and tries to run your plugin tests using the following command.

Important notes

• Please make sure that the extension of your plugin descriptor file is yml and not yaml.

• Please make sure your pull request includes only one or more plugin descriptors. Please do not add, edit or remove other files.

YAML format example

• pluginName - The name of the plugin. This name should match the plugin name set in the plugin's code.

• version - The version of the plugin. This version should have a v prefix and match the version set in the plugin's code.

• repository - The plugin's code GitHub repository URL.

Publishing a new version of a published plugin

To publish a new version of your plugin, all you need to do is create a pull request, which updates the version inside your plugin descriptor file. If needed, your change can also include either the branch or tag.

Setting up a private plugins registry

In addition to the public official JFrog CLI Plugins Registry, JFrog CLI supports publishing and installing plugins to and from private JFrog CLI Plugins Registries. A private registry can be hosted on any Artifactory server. It uses a local generic Artifactory repository for storing the plugins.

To create your own private plugins registry, follow these steps.

• On your Artifactory server, create a local generic repository named jfrog-cli-plugins.

• Make sure your Artifactory server is included in JFrog CLI's configuration, by running the jf c show command.

• If needed, configure your Artifactory instance using the jf c add command.

To publish a plugin to the private registry, run the following command, while inside the root of the plugin's sources directory. This command will build the sources of the plugin for all the supported operating systems. All binaries will be uploaded to the configured registry.

jf plugin publish the-plugin-name the-plugin-version

Testing your plugin before publishing it

When installing a plugin using the jf plugin install command, the plugin is downloaded into its own directory under the plugins directory, which is located under the JFrog CLI home directory. By default, you can find the plugins directory under ~/.jfrog/plugins/. So if for example you are developing a plugin named my-plugin, and you'd like to test it with JFrog CLI before publishing it, you'll need to place your plugin's executable, named my-plugin, under the following path -

If your plugin also uses , you should place the resources under the following path -

Once the plugin's executable is there, you'll be able to see it is installed by just running jf.

Having your plugin use external resources

General

In some cases your plugin may need to use external resources. For example, the plugin code may need to run an executable or read from a configuration file. You would therefore want these resources to be packaged together with the plugin, so that when it is installed, these resources are also downloaded and become available for the plugin.

How can you add resources to your plugin?

The way to include resources for your plugin, is to simply place them inside a directory named resources at the root of the plugin's sources directory. You can create any directory structure inside resources. When publishing the plugin, the content of the resources directory is published alongside the plugin executable. When installing the plugin, the resources are also downloaded.

How can your plugin code access the resources?

When installing a plugin, the plugin's resources are downloaded the following directory under the JFrog CLI home -

This means that during development, you'll need to make sure the resources are placed there, so that your plugin code can access them. Here's how your plugin code can access the resources directory -