Install JFrog CLI Plugins

Install or upgrade a JFrog CLI plugin from the JFrog CLI Plugins Registry.

Synopsis

jf plugin install <PLUGIN_NAME_AND_VERSION> [options]

Aliases: plugin i

Arguments

The following table lists jf plugin install arguments.

Options

The following table lists jf plugin install options.

Environment Variables

The following table lists environment variables for jf plugin install. For the complete list of JFrog CLI environment variables, see Environment Variables.

Examples

Show Help

To show install command help:

• Run the following command.

  Bash

  jf plugin install --help

Install Latest Version

To install the latest version of a plugin:

• Run:

  Bash

  jf plugin install <PLUGIN_NAME>

  Where:

  • <PLUGIN_NAME>: Name of the plugin in the registry

  For example:

  Bash

  jf plugin install rt-fs

Expected output:

[Info] Downloading: rt-fs
[Info] Downloading: rt-fs
[Info] Plugin downloaded successfully.

jf rt-fs --version

Install Specific Version

To install a specific version of a plugin:

• Run:

  Bash

  jf plugin install <PLUGIN_NAME>@<VERSION>

  Where:

  • <PLUGIN_NAME>: Plugin name
  • <VERSION>: Version string as published (for example, v1.1.5 or 1.0.0)

  For example:

  Bash

  jf plugin install [email protected]

Expected output:

[Info] Downloading: rt-fs
[Info] Downloading: rt-fs
[Info] Plugin downloaded successfully.

To verify the installation:

• List the plugin directory.

  Bash

  ls ~/.jfrog/plugins/

Upgrading or Switching Versions

To change the installed version of a plugin:

1. Uninstall the existing plugin.

2. Install the target version:

   Bash

   jf plugin uninstall <PLUGIN_NAME>
   jf plugin install <PLUGIN_NAME>@<VERSION>

   Where:

   • <PLUGIN_NAME>: Plugin name
   • <VERSION>: Desired version as published in the registry

   For example:

   Bash

   jf plugin uninstall rt-fs
   jf plugin install [email protected]

Install from Custom Registry

To install a plugin from a custom JFrog Artifactory registry:

• Set the server and optional repository, then install:

  Bash

  export JFROG_CLI_PLUGINS_SERVER=<SERVER_ID>
  export JFROG_CLI_PLUGINS_REPO=<REPOSITORY_NAME>
  jf plugin install <PLUGIN_NAME>

  Where:

  • <SERVER_ID>: JFrog CLI server identifier that points at your JFrog Artifactory instance. See Add a Server Configuration to configure one.
  • <REPOSITORY_NAME>: Local generic repository name on that server. Set this only if you are not using the default jfrog-cli-plugins repository.
  • <PLUGIN_NAME>: Plugin name in that registry.

  For example:

  Bash

  export JFROG_CLI_PLUGINS_SERVER=my-artifactory
  export JFROG_CLI_PLUGINS_REPO=jfrog-cli-plugins
  jf plugin install my-internal-plugin

When to Use

Use jf plugin install to extend JFrog CLI with community or custom plugins. Plugins add new commands that are not part of the core CLI. For available plugins, see the JFrog CLI Plugins Registry. To create your own, see Publish JFrog CLI Plugins to a Registry.

Important Notes

• Version format. Use plugin-name@version to install a specific version. The version must match the registry (often v-prefixed, for example [email protected]. The CLI also accepts forms like [email protected], as in built-in help). Omit the version to install the latest.
• Custom registry. Set JFROG_CLI_PLUGINS_SERVER and JFROG_CLI_PLUGINS_REPO to download plugins from your own JFrog Artifactory instance. This helps in air-gapped environments or when you use enterprise-approved plugin sets.
• Install location. Plugins are installed in ~/.jfrog/plugins/, or in $JFROG_CLI_HOME_DIR/plugins/ when you set that variable.
• Upgrades. Always uninstall the existing version before you install a different one. Running jf plugin install directly over an existing plugin can corrupt and delete the installation. For more information, see Upgrading or Switching Versions.
• Failed installs. If installation fails, any partially downloaded files are cleaned up automatically. Run the install command again to retry.
• macOS on Apple Silicon and Intel. Plugin binaries must be notarized by Apple to run on macOS. If a plugin is not notarized, macOS Gatekeeper blocks execution and the install fails. Contact the plugin author if you encounter a security or permission error after a successful download. As a workaround, you can clear the quarantine flag manually with xattr -d com.apple.quarantine ~/.jfrog/plugins/<PLUGIN_NAME>/bin/<PLUGIN_NAME>.

Troubleshooting

Error: 404 when installing a plugin

Cause: The plugin name is incorrect, or the specified version does not exist in the registry.

To resolve a 404 when installing:

1. Verify the exact plugin name in the JFrog CLI Plugins Registry

2. If specifying a version, ensure it exactly matches the published version string for that plugin

3. Try installing without a version to get the latest:

   Bash

   jf plugin install <PLUGIN_NAME>

   Where:

   • <PLUGIN_NAME>: Registry name of the plugin

Error: chmod ... no such file or directory on macOS

Cause: macOS Gatekeeper is preventing the downloaded plugin binary from being set as executable. The binary exists on disk but the OS security layer blocks the operation.

To recover on macOS:

1. Manually clear the quarantine attribute and set permissions:

   Bash

   xattr -d com.apple.quarantine ~/.jfrog/plugins/<PLUGIN_NAME>/bin/<PLUGIN_NAME>
   chmod +x ~/.jfrog/plugins/<PLUGIN_NAME>/bin/<PLUGIN_NAME>

   Where:

   • <PLUGIN_NAME>: Plugin name

   For example:

   Bash

   xattr -d com.apple.quarantine ~/.jfrog/plugins/rt-fs/bin/rt-fs
   chmod +x ~/.jfrog/plugins/rt-fs/bin/rt-fs

2. If the plugin directory was deleted by the failed install, run jf plugin install <PLUGIN_NAME> again and immediately apply the preceding fix before the CLI cleans up.

3. Contact the plugin author to request that they notarize their macOS binaries.

Startup [Error] messages appear before every command

Cause: A previously installed plugin is corrupt, incompatible with the current JFrog CLI version, or blocked by the operating system.

To remove a broken plugin:

1. Uninstall and reinstall:

   Bash

   jf plugin uninstall <PLUGIN_NAME>
   jf plugin install <PLUGIN_NAME>

   Where:

   • <PLUGIN_NAME>: Plugin to replace

2. If the plugin directory no longer appears under ~/.jfrog/plugins/ but errors persist, confirm no stale plugin directory remains under ~/.jfrog/plugins/<PLUGIN_NAME>/. ~/.jfrog/plugins/plugins.yml is a schema-version marker file (for example {"version":1}). It does not list individual installed plugins, so it is not useful for finding stale entries.

   Bash

   ls ~/.jfrog/plugins/

Frequently Asked Questions

This section provides answers to frequently asked questions.

Related Topics

• Publish JFrog CLI Plugins to a Registry
• Uninstall JFrog CLI Plugins
• JFrog CLI Plugins
• Add a Server Configuration
• JFrog CLI Command Reference