--- summary: "Quick examples for listing, installing, updating, inspecting, and uninstalling OpenClaw plugins" read_when: - You want quick plugin list, install, update, inspect, or uninstall examples - You want to choose a plugin install source - You want the right reference for publishing plugin packages title: "Manage plugins" sidebarTitle: "Manage plugins" doc-schema-version: 1 --- Common plugin management commands. For the full command contract, flags, source-selection rules, and edge cases, see [`openclaw plugins`](/cli/plugins). Typical workflow: find a package, install it from ClawHub, npm, git, or a local path, let the managed Gateway auto-restart (or restart it manually), then verify the plugin's runtime registrations. ## List and search plugins ```bash openclaw plugins list openclaw plugins list --enabled openclaw plugins list --verbose openclaw plugins list --json openclaw plugins search "calendar" ``` `--json` for scripts: ```bash openclaw plugins list --json \ | jq '.plugins[] | {id, enabled, format, source, dependencyStatus}' ``` `plugins list` is a cold inventory check: what OpenClaw can discover from config, manifests, and the persisted plugin registry. It does not prove an already-running Gateway imported the plugin runtime. JSON output includes registry diagnostics and each plugin's `dependencyStatus` (whether declared `dependencies`/`optionalDependencies` resolve on disk). `plugins search` queries ClawHub for installable plugin packages and prints an install hint (`openclaw plugins install clawhub:`) per result. ## Enable and disable plugins ```bash openclaw plugins enable openclaw plugins disable ``` Toggles a plugin's config entry without touching installed files. Some bundled plugins (bundled model/speech providers, the bundled browser plugin) are enabled by default; others require `enable` after install. ## Install plugins ```bash # Search ClawHub for plugin packages. openclaw plugins search "calendar" # Install from ClawHub. openclaw plugins install clawhub: openclaw plugins install clawhub:@1.2.3 openclaw plugins install clawhub:@beta # Install from npm. openclaw plugins install npm: openclaw plugins install npm:@scope/openclaw-plugin@1.2.3 openclaw plugins install npm:@openclaw/codex # Install from a local npm-pack artifact. openclaw plugins install npm-pack: # Install from git or a local development checkout. openclaw plugins install git:github.com/acme/openclaw-plugin@v1.0.0 openclaw plugins install ./my-plugin openclaw plugins install --link ./my-plugin ``` Bare package specs install from npm during the launch cutover, unless the name matches a bundled or official plugin id, in which case OpenClaw uses that local/official copy instead. Use `clawhub:`, `npm:`, `git:`, or `npm-pack:` for deterministic source selection. Use `--force` only to overwrite an existing install target from a different source. For routine upgrades of a tracked npm, ClawHub, or hook-pack install, use `openclaw plugins update` instead; `--force` is not supported with `--link`. ## Restart and inspect A running managed Gateway with config reload enabled restarts automatically after installing, updating, or uninstalling plugin code. If the Gateway is unmanaged or reload is disabled, restart it yourself before checking live runtime surfaces: ```bash openclaw gateway restart openclaw plugins inspect --runtime --json ``` `inspect --runtime` loads the plugin module and proves it registered runtime surfaces (tools, hooks, services, Gateway methods, HTTP routes, plugin-owned CLI commands). Plain `inspect` and `list` are cold manifest/config/registry checks only. ## Update plugins ```bash openclaw plugins update openclaw plugins update openclaw plugins update --all openclaw plugins update --dry-run ``` Passing a plugin id reuses its tracked install spec: stored dist-tags (`@beta`) and exact pinned versions carry over to later `update ` runs. `openclaw plugins update --all` is the bulk maintenance path. It still respects ordinary tracked install specs, but trusted official OpenClaw plugin records sync to the current official catalog target instead of staying pinned to a stale exact official package; when `update.channel` is `beta`, that sync prefers the beta release line. Use a targeted `update ` to keep an exact or tagged official spec untouched. For npm installs, pass an explicit package spec to switch the tracked record: ```bash openclaw plugins update @scope/openclaw-plugin@beta openclaw plugins update @scope/openclaw-plugin ``` The second command moves a plugin back to the registry's default release line when it was previously pinned to an exact version or tag. See [`openclaw plugins`](/cli/plugins#update) for the exact fallback and pinning rules. ## Uninstall plugins ```bash openclaw plugins uninstall --dry-run openclaw plugins uninstall openclaw plugins uninstall --keep-files ``` Uninstall removes the plugin's config entry, persisted plugin index record, allow/deny list entries, and linked `plugins.load.paths` entries when applicable. The managed install directory is removed unless you pass `--keep-files`. A running managed Gateway restarts automatically when the uninstall changes plugin source. In Nix mode (`OPENCLAW_NIX_MODE=1`), plugin install, update, uninstall, enable, and disable are all disabled; manage those choices in the Nix source for the install instead. ## Choose a source | Source | Use when | Example | | ----------- | --------------------------------------------------------------------------- | -------------------------------------------------------------- | | ClawHub | You want OpenClaw-native discovery, scan summaries, versions, and hints | `openclaw plugins install clawhub:` | | git | You want a branch, tag, or commit from a repository | `openclaw plugins install git:github.com//@` | | local path | You are developing or testing a plugin on the same machine | `openclaw plugins install --link ./my-plugin` | | marketplace | You are installing a Claude-compatible marketplace plugin | `openclaw plugins install --marketplace ` | | npm pack | You are proving a local package artifact through npm install semantics | `openclaw plugins install npm-pack:` | | npmjs.com | You already ship JavaScript packages or need npm dist-tags/private registry | `openclaw plugins install npm:@acme/openclaw-plugin` | Managed local path installs must be plugin directories or archives. Put standalone plugin files in `plugins.load.paths` instead of installing them with `plugins install`. ## Publish plugins ClawHub is the primary public discovery surface for OpenClaw plugins. Publish there when you want users to find plugin metadata, version history, registry scan results, and install hints before they install. ```bash npm i -g clawhub clawhub login clawhub package publish your-org/your-plugin --dry-run clawhub package publish your-org/your-plugin clawhub package publish your-org/your-plugin@v1.0.0 ``` Native npm plugins must ship a plugin manifest (`openclaw.plugin.json`) plus `package.json` metadata before publishing: ```json package.json { "name": "@acme/openclaw-plugin", "version": "1.0.0", "type": "module", "openclaw": { "extensions": ["./dist/index.js"] } } ``` ```bash npm publish --access public openclaw plugins install npm:@acme/openclaw-plugin openclaw plugins install npm:@acme/openclaw-plugin@beta openclaw plugins install npm:@acme/openclaw-plugin@1.0.0 ``` Use these pages for the full publishing contract instead of treating this page as the publishing reference: - [ClawHub publishing](/clawhub/publishing) explains owners, scopes, releases, review, package validation, and package transfer. - [Building plugins](/plugins/building-plugins) shows the full plugin package shape (including `openclaw.plugin.json`) and first publish workflow. - [Plugin manifest](/plugins/manifest) defines native plugin manifest fields. If the same package is available on both ClawHub and npm, use the explicit `clawhub:` or `npm:` prefix to force one source. ## Related - [Plugins](/tools/plugin) - install, configure, restart, and troubleshoot - [`openclaw plugins`](/cli/plugins) - full CLI reference - [Community plugins](/plugins/community) - public discovery and ClawHub publishing - [ClawHub](/clawhub/cli) - registry CLI operations - [Building plugins](/plugins/building-plugins) - create a plugin package - [Plugin manifest](/plugins/manifest) - manifest and package metadata