Aller au contenu

Gérer les plugins

Utilisez cette page pour les commandes courantes de gestion de plugins. Pour le contrat complet des commandes, les indicateurs, les règles de sélection de source et les cas particuliers, consultez openclaw plugins.

La plupart des flux d’installation consistent à :

  1. trouver un package
  2. l’installer depuis ClawHub, npm, git ou un chemin local
  3. laisser la Gateway gérée redémarrer automatiquement, ou la redémarrer manuellement si elle n’est pas gérée
  4. vérifier les enregistrements d’exécution du plugin
Fenêtre de terminal
openclaw plugins list
openclaw plugins list --enabled
openclaw plugins list --verbose
openclaw plugins list --json
openclaw plugins search "calendar"

Utilisez --json pour les scripts :

Fenêtre de terminal
openclaw plugins list --json \
| jq '.plugins[] | {id, enabled, format, source, dependencyStatus}'

plugins listOpenClawGateway est une vérification à froid de l’inventaire. Il montre ce qu’OpenClaw peut découvrir à partir de la configuration, des manifestes et du registre de plugins ; cela ne prouve pas qu’une Gateway déjà en cours d’exécution a importé le runtime du plugin. La sortie JSON inclut les diagnostics du registre et le dependencyStatus statique de chaque plugin lorsque le package de plugin déclare dependencies ou optionalDependencies.

plugins searchClawHub interroge ClawHub pour les packages de plugins installables et affiche des conseils d’installation tels que openclaw plugins install clawhub:<package>.

Fenêtre de terminal
# Search ClawHub for plugin packages.
openclaw plugins search "calendar"
# Install from ClawHub.
openclaw plugins install clawhub:<package>
openclaw plugins install clawhub:<package>@1.2.3
openclaw plugins install clawhub:<package>@beta
# Install from npm.
openclaw plugins install npm:<package>
openclaw plugins install npm:@scope/[email protected]
openclaw plugins install npm:@openclaw/codex
# Install from a local npm pack artifact.
openclaw plugins install npm-pack:<path.tgz>
# Install from git or a local development checkout.
openclaw plugins install git:github.com/acme/[email protected]
openclaw plugins install ./my-plugin
openclaw plugins install --link ./my-plugin

Les spécifications de packages nues s’installent depuis npm lors du basculement de lancement. Utilisez npmclawhub:, npm:, git: ou npm-pack:OpenClaw lorsque vous avez besoin d’une sélection déterministe de la source. Si le nom nu correspond à un identifiant de plugin officiel, OpenClaw peut installer l’entrée de catalogue directement.

Utilisez --forcenpmClawHub uniquement lorsque vous souhaitez intentionnellement écraser une cible d’installation existante. Pour les mises à niveau courantes des installations suivies depuis npm, ClawHub ou hook-pack, utilisez openclaw plugins update.

Après l’installation, la mise à jour ou la désinstallation du code du plugin, un Gateway géré en cours d’exécution avec le rechargement de la configuration activé redémarre automatiquement. Si le Gateway n’est pas géré ou si le rechargement est désactivé, redémarrez-le vous-même avant de vérifier les surfaces d’exécution en direct :

Fenêtre de terminal
openclaw gateway restart
openclaw plugins inspect <plugin-id> --runtime --json

Utilisez inspect --runtime lorsque vous avez besoin d’une preuve que le plugin a enregistré des surfaces d’exécution telles que des outils, des crochets (hooks), des services, des méthodes de Gateway, des routes HTTP ou des commandes CLI propres au plugin. inspect et list simples sont des vérifications à froid du manifeste, de la configuration et du registre.

Fenêtre de terminal
openclaw plugins update <plugin-id>
openclaw plugins update <npm-package-or-spec>
openclaw plugins update --all
openclaw plugins update <plugin-id> --dry-run

Lorsque vous transmettez un identifiant de plugin, OpenClaw réutilise la spécification d’installation suivie. Les balises de distribution (dist-tags) stockées telles que @beta et les versions épinglées exactes continuent d’être utilisées lors des exécutions ultérieures de update <plugin-id>.

Pour les installations npm, vous pouvez transmettre une spécification de package explicite pour modifier l’enregistrement suivi :

Fenêtre de terminal
openclaw plugins update @scope/openclaw-plugin@beta
openclaw plugins update @scope/openclaw-plugin

La deuxième commande ramène un plugin à la ligne de publication par défaut du registre lorsqu’il était précédemment épinglé à une version ou une balise exacte.

Lorsque openclaw update s’exécute sur le canal bêta, les enregistrements de plugins peuvent préférer les versions @beta correspondantes. Pour les règles exactes de repli et d’épinglage, consultez openclaw plugins.

Fenêtre de terminal
openclaw plugins uninstall <plugin-id> --dry-run
openclaw plugins uninstall <plugin-id>
openclaw plugins uninstall <plugin-id> --keep-files

La désinstallation supprime l’entrée de configuration du plugin, l’enregistrement de l’index du plugin persisté, les entrées des listes d’autorisation/refus et les chemins de chargement liés, le cas échéant. Les répertoires d’installation gérés sont supprimés sauf si vous transmettez --keep-files. Un Gateway géré en cours d’exécution redémarre automatiquement lorsque la désinstallation modifie la source du plugin.

En mode Nix (OPENCLAW_NIX_MODE=1), les commandes d’installation, de mise à jour, de désinstallation, d’activation et de désactivation de plugins sont désactivées. Gérez plutôt ces choix dans la source Nix pour l’installation.

SourceUtiliser quandExemple
ClawHubVous souhaitez une découverte native OpenClaw, des résumés d’analyse, des versions et des indicesopenclaw plugins install clawhub:<package>
npmjs.comVous livrez déjà des packages JavaScript ou avez besoin de balises de distribution/registre privé npmopenclaw plugins install npm:@acme/openclaw-plugin
gitVous souhaitez une branche, une étiquette ou un commit provenant d’un dépôtopenclaw plugins install git:github.com/<owner>/<repo>@<ref>
chemin localVous développez ou testez un plugin sur la même machineopenclaw plugins install --link ./my-plugin
npm packVous fournissez un artifact de package local via la sémantique d’installation npmopenclaw plugins install npm-pack:<path.tgz>
place de marchéVous installez un plugin de place de marché compatible avec Claudeopenclaw plugins install <plugin> --marketplace <source>

ClawHub est la principale surface de découverte publique pour les plugins OpenClaw. Publiez y lorsque vous souhaitez que les utilisateurs trouvent les métadonnées du plugin, l’historique des versions, les résultats de l’analyse du registre et les conseils d’installation avant d’installer.

Fenêtre de terminal
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/[email protected]

Les plugins natifs npm doivent inclure un manifeste de plugin et les métadonnées du package avant la publication :

{
"name": "@acme/openclaw-plugin",
"version": "1.0.0",
"type": "module",
"openclaw": {
"extensions": ["./dist/index.js"]
}
}
Fenêtre de terminal
npm publish --access public
openclaw plugins install npm:@acme/openclaw-plugin
openclaw plugins install npm:@acme/openclaw-plugin@beta
openclaw plugins install npm:@acme/[email protected]

Utilisez ces pages pour le contrat de publication complet au lieu de traiter cette page comme la référence de publication :

  • Publication sur ClawHub explique les propriétaires, les portées, les versions, la révision, la validation des packages et le transfert de packages.
  • Création de plugins montre la structure du package de plugin et le premier flux de publication.
  • Manifeste de plugin définit les champs du manifeste de plugin natif.

Si le même package est disponible à la fois sur ClawHub et npm, utilisez le préfixe explicite clawhub: ou npm: lorsque vous devez forcer une source.