Skip to content

Installing Plugins

Plugins can be installed from the official xcore Marketplace or from external sources like Git repositories.

Installing from Marketplace

The easiest way to add features. xcorecli handles downloads and HMAC signature verification.

Two credentials required

Marketplace installs need both an API key and a signing key configured first — see Authentication. Missing either one fails fast with a clear message telling you which one and how to set it; nothing is extracted until the signature checks out.

Marketplace Install
xcli plugin install name-of-plugin

Shortcut

xcli install name-of-plugin works too — a top-level alias for xcli plugin install, same command underneath.

Installing a Specific Version

xcli plugin install name-of-plugin@1.2.3

To see all available versions for a plugin:

xcli plugin versions name-of-plugin

Installing from Git or a Local Zip

You can install plugins directly from a Git repository or a .zip file instead of the marketplace — neither one goes through HMAC verification, that's marketplace-only, so run xcli plugin health afterward (see below).

Git Install
xcli plugin install my-plugin --source git --url https://github.com/user/plugin.git
Zip Install
xcli plugin install my-plugin --source zip --url ./path/to/plugin.zip

--url is required for both git and zip — omitting it fails fast rather than falling back to the marketplace.

Reinstalling

xcli plugin install name-of-plugin --force     # overwrite an existing install

Without --force, installing over an already-installed plugin (same name) is refused with a one-line message telling you to add the flag.

--no-deps currently has no effect

The flag is accepted (install --no-deps) but the installer never reads it — confirmed in xcli/plugin/install_commands.py: dependencies install the same way whether or not you pass it. Not documented as working here on purpose; treat it as reserved for now.

Management Commands

Detailed Info

Get a full report on an installed plugin, including its author, description, requested permissions, and resource limits.

xcli plugin info name-of-plugin

Health Check

Verify the integrity of all installed plugins. This checks if manifests are valid, signatures match, and if sandboxed plugins follow AST import rules.

xcli plugin health

Removal

Uninstall a plugin and remove its directory.

xcli plugin remove name-of-plugin

Security

xcorecli verifies the HMAC signature of marketplace plugins. For Git or local installs, we recommend running xcli plugin health after installation.