Get started

CLI

CLI

CLI パッケージ: clawhub、bin: clawhub

npm または pnpm でグローバルにインストールします。

bash
npm i -g clawhub# orpnpm add -g clawhub

その後、確認します。

bash
clawhub --helpclawhub loginclawhub whoami

グローバルフラグ

  • --workdir <dir>: 作業ディレクトリ (デフォルト: cwd。設定されている場合は Clawdbot ワークスペースにフォールバック)
  • --dir <dir>: workdir 配下のインストール先ディレクトリ (デフォルト: skills)
  • --site <url>: ブラウザログイン用のベース URL (デフォルト: https://clawhub.ai)
  • --registry <url>: API ベース URL (デフォルト: 検出されたもの、なければ https://clawhub.ai)
  • --no-input: プロンプトを無効化

環境変数の等価設定:

  • CLAWHUB_SITE (レガシー CLAWDHUB_SITE)
  • CLAWHUB_REGISTRY (レガシー CLAWDHUB_REGISTRY)
  • CLAWHUB_WORKDIR (レガシー CLAWDHUB_WORKDIR)

HTTP プロキシ

CLI は、企業プロキシや制限されたネットワークの背後にあるシステム向けに、標準の HTTP プロキシ環境変数を尊重します。

  • HTTPS_PROXY / https_proxy
  • HTTP_PROXY / http_proxy
  • NO_PROXY / no_proxy

これらの変数のいずれかが設定されている場合、CLI は送信リクエストを指定されたプロキシ経由でルーティングします。HTTPS_PROXY は HTTPS リクエストに、HTTP_PROXY はプレーン HTTP に使用されます。NO_PROXY / no_proxy は、特定のホストまたはドメインでプロキシをバイパスするために尊重されます。

これは、直接の外向き接続がブロックされているシステムで必要です (例: Docker コンテナ、プロキシのみのインターネットを使用する Hetzner VPS、企業ファイアウォール)。

例:

bash
export HTTPS_PROXY=http://proxy.example.com:3128export NO_PROXY=localhost,127.0.0.1clawhub search "my query"

プロキシ変数が設定されていない場合、動作は変わりません (直接接続)。

設定ファイル

API トークンとキャッシュされたレジストリ URL を保存します。

  • macOS: ~/Library/Application Support/clawhub/config.json
  • Linux/XDG: $XDG_CONFIG_HOME/clawhub/config.json または ~/.config/clawhub/config.json
  • Windows: %APPDATA%\\clawhub\\config.json
  • レガシーフォールバック: clawhub/config.json がまだ存在せず、clawdhub/config.json が存在する場合、CLI はレガシーパスを再利用します
  • オーバーライド: CLAWHUB_CONFIG_PATH (レガシー CLAWDHUB_CONFIG_PATH)

コマンド

login / auth login

  • デフォルト: ブラウザで <site>/cli/auth を開き、ループバックコールバック経由で完了します。
  • ヘッドレス: clawhub login --token clh_...
  • リモート/ヘッドレス対話式: clawhub login --device はコードを表示し、<site>/cli/device で認可するまで待機します。

whoami

  • 保存済みトークンを /api/v1/whoami 経由で検証します。

token

  • 保存済み API トークンを標準出力に出力します。
  • ローカルログイントークンを CI シークレット設定コマンドへパイプする場合に便利です。

star <skill> / unstar <skill>

  • ハイライトにスキルを追加または削除します。
  • POST /api/v1/stars/<slug>DELETE /api/v1/stars/<slug> を呼び出します。
  • --yes は確認をスキップします。

search <query...>

  • /api/v1/search?q=... を呼び出します。
  • 出力には、スキルスラッグ、所有者ハンドル、表示名、関連度スコアが含まれます。
  • 検索では、ダウンロード人気度よりも、完全なスラッグ/名前トークン一致が優先されます。map のような独立したスラッグトークンは、amap 内の部分文字列よりも personal-map に強く一致します。
  • 人気度は小さなランキング事前情報であり、上位表示を保証するものではありません。
  • スキルが表示されるべきなのに表示されない場合は、メタデータをリネームする前に、ログインした状態で clawhub inspect @owner/slug を実行し、所有者に表示されるモデレーション診断を確認してください。

explore

  • /api/v1/skills?limit=...&sort=createdAt 経由で最新のスキルを一覧表示します (createdAt 降順でソート)。
  • フラグ:
    • --limit <n> (1-200、デフォルト: 25)
    • --sort newest|updated|rating|downloads|trending (デフォルト: newest)。レガシーのインストールソートエイリアスも互換性のため引き続き動作します。
    • --json (機械可読の出力)
  • 出力: <slug> v<version> <age> <summary> (summary は 50 文字に切り詰め)。

inspect @owner/slug

  • インストールせずに、スキルメタデータとバージョンファイルを取得します。
  • --version <version>: 特定のバージョンを調査します (デフォルト: latest)。
  • --tag <tag>: タグ付きバージョンを調査します (例: latest)。
  • --versions: バージョン履歴を一覧表示します (最初のページ)。
  • --limit <n>: 一覧表示する最大バージョン数 (1-200)。
  • --files: 選択したバージョンのファイルを一覧表示します。
  • --file <path>: 生のファイル内容を取得します (テキストファイルのみ、200KB 制限)。
  • --json: 機械可読の出力。

install @owner/slug

  • 指定された所有者とスキルの最新バージョンを解決します。
  • /api/v1/download 経由で zip をダウンロードします。
  • <workdir>/<dir>/<slug> に展開します。
  • ピン留めされたスキルの上書きを拒否します。先に clawhub unpin <skill> を実行してください。
  • 書き込み先:
    • <workdir>/.clawhub/lock.json (レガシー .clawdhub)
    • <skill>/.clawhub/origin.json (レガシー .clawdhub)

uninstall <skill>

  • <workdir>/<dir>/<slug> を削除し、lockfile のエントリを削除します。
  • ログイン中は、現在のインストール数を無効化できるようベストエフォートのテレメトリを送信します。
  • 対話式: 確認を求めます。
  • 非対話式 (--no-input): --yes が必要です。

list

  • <workdir>/.clawhub/lock.json (レガシー .clawdhub) を読み取ります。
  • clawhub pin で固定されたスキルの横に pinned を表示し、任意の理由も含めます。

pin <skill>

  • インストール済みスキルを lockfile 内でピン留め済みとしてマークします。
  • --reason <text> は、スキルを固定する理由を記録します。
  • ピン留めされたスキルは update --all でスキップされ、直接の update <skill> では拒否されます。
  • ピン留めされたスキルは install --force も拒否するため、ローカルのバイト列が誤って置き換えられることはありません。

unpin <skill>

  • インストール済みスキルから lockfile のピンを削除し、今後の更新で変更できるようにします。

update [@owner/slug] / update --all

  • ローカルファイルからフィンガープリントを計算します。
  • フィンガープリントが既知のバージョンと一致する場合: プロンプトはありません。
  • フィンガープリントが一致しない場合:
    • デフォルトでは拒否します
    • --force で上書きします (対話式の場合はプロンプト)
  • ピン留めされたスキルは --force でも更新されません。
  • update <skill> はピン留めされたスキルでは即座に失敗し、先に clawhub unpin <skill> を実行するよう案内します。
  • update --all はピン留めされたスラッグをスキップし、固定されたままのものの概要を出力します。

skill publish <path>

  • ローカルバンドルのフィンガープリントを ClawHub と比較し、内容がすでに公開済みの場合は成功として終了します。
  • 新しいスキルのデフォルトは 1.0.0 です。変更されたスキルのデフォルトは次のパッチバージョンです。
  • --version <version> はバージョンを明示的に選択し、内容が既存バージョンと一致する場合でも公開します。
  • --dry-run はアップロードせずに公開を解決します。--json は機械可読の結果を出力します。
  • --owner <handle> は、実行者に公開者アクセスがある場合に、組織/ユーザーの公開者ハンドル配下で公開します。
  • --migrate-owner は、新しいバージョンを公開しながら既存のスキルを --owner に移動します。両方の公開者に対する admin/owner アクセスが必要です。
  • 所有者とレビューの動作は docs/publishing.md で説明されています。
  • スキルを公開すると、ClawHub 上で MIT-0 の下にリリースされます。
  • 公開済みスキルは、帰属表示なしで自由に使用、変更、再配布できます。
  • ClawHub は有料スキルやスキルごとの価格設定をサポートしていません。
  • レガシーエイリアス: publish <path>
bash
clawhub skill publish ./my-skill --dry-runclawhub skill publish ./my-skillclawhub skill publish ./my-skill --version 2.0.0

GitHub Actions

ClawHub の再利用可能な skill-publish.yml ワークフローは、1 つの skill_path、または root 配下の直下の各スキルフォルダ (デフォルト: skills) に対して skill publish を呼び出します。変更されていないスキルはスキップし、同じ自動パッチバージョン動作を使用します。

トークンなしでプレビューするには dry_run: true を設定します。実際の公開には clawhub_token シークレットが必要です。

sync

  • 現在の workdir、設定済みのスキルディレクトリ、および --root <dir> フォルダをスキャンし、SKILL.md または skill.md を含むローカルスキルフォルダを探します。
  • 各ローカルスキルのフィンガープリントを ClawHub と比較し、新規または変更されたスキルのみを公開します。
  • 新しいスキルは 1.0.0 として公開されます。変更されたスキルはデフォルトで次のパッチバージョンとして公開されます。より大きな semver ステップで進めるべき更新バッチには --bump minor|major を使用します。
  • --dry-run はアップロードせずに公開計画を表示します。--json は機械可読の計画を出力します。
  • --all は、プロンプトなしで新規または変更されたすべてのスキルを公開します。--all がない場合、対話式ターミナルでは公開するスキルを選択できます。
  • --owner <handle> は、実行者に公開者アクセスがある場合に、組織/ユーザーの公開者ハンドル配下で公開します。
  • sync は一方向の公開のみです。インストール、更新、ダウンロード、インストール/ダウンロードテレメトリの報告は行いません。
bash
clawhub sync --all --dry-runclawhub sync --allclawhub sync --root ./skills --owner openclaw --bump minor

scan --slug <slug>

  • clawhub login が必要です。
  • POST /api/v1/skills/-/scan 経由で ClawHub ClawScan を実行し、その後スキャンが終端状態になるまでポーリングします。
  • スキャンは非同期で、完了まで時間がかかる場合があります。キュー内にある間、ターミナルのスピナーには現在の優先スキャン位置と、前にあるスキャン数が表示されます。
  • 公開済みスキャンには、所有権または公開者管理アクセスが必要です。モデレーター/admin は clawhub-admin を通じて同じバックエンドを使用できます。
  • --update--slug と併用する場合のみ有効です。成功した公開済みスキャン結果を、選択したバージョンに書き戻します。
  • --output <file.zip> は、manifest.jsonclawscan.jsonskillspector.jsonstatic-analysis.jsonvirustotal.jsonREADME.md を含む完全なレポートアーカイブをダウンロードします。
  • --json は自動化向けに完全なポーリングレスポンスを出力します。
  • ローカルパススキャンはサポートされなくなりました。新しいバージョンをアップロードしてから、scan download を使用して、その送信バージョンに保存されたスキャン結果を取得してください。
bash
clawhub scan --slug gifgrepclawhub scan --slug gifgrep --version 1.2.3clawhub scan --slug gifgrep --update --output report.zip

scan download <name>

  • clawhub login が必要です。
  • ClawHub のセキュリティチェックでブロックまたは非表示にされたバージョンを含め、送信済みのスキルまたは Plugin バージョンの保存済みスキャンレポート ZIP をダウンロードします。
  • スキルのダウンロードではスキルスラッグを使用し、デフォルトは --kind skill です。
  • Plugin のダウンロードではパッケージ名を使用し、--kind plugin が必要です。
  • 作者が ClawHub によってブロックされた正確な送信バージョンを調査できるよう、--version が必要です。
  • --output <file.zip> は宛先パスを選択します。
bash
clawhub scan download gifgrep --version 1.2.3clawhub scan download @scope/demo --version 2.0.0 --kind plugin --output report.zip

GitHub Actions

ClawHub は、スキルリポジトリとカタログリポジトリ向けに、公式の再利用可能なワークフローを /.github/workflows/skill-publish.yml で提供しています。

典型的なカタログ設定:

yaml
name: Skill Publish on:  pull_request:  workflow_dispatch: jobs:  dry-run:    if: github.event_name == 'pull_request'    uses: openclaw/clawhub/.github/workflows/skill-publish.yml@v1    with:      owner: nvidia      dry_run: true   publish:    if: github.event_name == 'workflow_dispatch'    uses: openclaw/clawhub/.github/workflows/skill-publish.yml@v1    with:      owner: nvidia      dry_run: false    secrets:      clawhub_token: ${{ secrets.CLAWHUB_TOKEN }}

注記:

  • カタログリポジトリでは、root のデフォルトは skills です。
  • 1 つのスキルフォルダを処理するには、skill_path: skills/review-helper を渡します。
  • owner は CLI の --owner フラグに対応します。認証済みユーザーとして公開する場合は省略します。
  • V1 のスキル公開は clawhub_token を使用します。GitHub OIDC 信頼済み公開は、現時点ではパッケージ専用です。

delete <skill>

  • --version なしでは、スキルをソフト削除します(所有者、モデレーター、または管理者)。
  • DELETE /api/v1/skills/{slug} を呼び出します。
  • 所有者によるソフト削除では slug が 30 日間予約されます。このコマンドは有効期限を出力します。
  • --version <version> は、fail-closed のバージョン固有ルートを通じて、所有する非最新バージョン 1 つを完全に削除します。 削除されたバージョンは復元または再公開できません。現在の最新バージョンを削除する前に、代替を公開してください。プラットフォームスタッフは、このバージョン限定フローで所有権を迂回しません。
  • --reason <text> は、スキル全体のソフト削除と監査ログにモデレーションメモを記録します。
  • --note <text>--reason のエイリアスです。
  • --yes は確認をスキップします。

undelete <skill>

  • 非表示のスキルを復元します(所有者、モデレーター、または管理者)。
  • バージョンの削除取り消しはありません。完全に削除されたバージョンは復元できません。
  • POST /api/v1/skills/{slug}/undelete を呼び出します。
  • --reason <text> は、スキルと監査ログにモデレーションメモを記録します。
  • --note <text>--reason のエイリアスです。
  • --yes は確認をスキップします。

hide <skill>

  • スキルを非表示にします(所有者、モデレーター、または管理者)。
  • delete のエイリアスです。

unhide <skill>

  • スキルの非表示を解除します(所有者、モデレーター、または管理者)。
  • undelete のエイリアスです。

skill rename <skill> <new-name>

  • 所有するスキルの名前を変更し、以前の slug をリダイレクトエイリアスとして保持します。
  • POST /api/v1/skills/{slug}/rename を呼び出します。
  • --yes は確認をスキップします。

skill merge <source> <target>

  • 所有するスキル 1 つを、別の所有するスキルに統合します。
  • ソース slug は公開一覧に表示されなくなり、ターゲットへのリダイレクトエイリアスになります。
  • POST /api/v1/skills/{sourceSlug}/merge を呼び出します。
  • --yes は確認をスキップします。

transfer

  • 所有権移譲ワークフロー。
  • ユーザーハンドルへの移譲は、受信者が承諾する保留中リクエストを作成します。
  • org/パブリッシャーハンドルへの移譲は、実行者が現在の所有者と移譲先パブリッシャーの両方に対する管理者アクセス権を持つ場合にのみ即時適用されます。
  • サブコマンド:
    • transfer request <skill> <handle> [--message "..."] [--yes]
    • transfer list [--outgoing]
    • transfer accept <skill> [--yes]
    • transfer reject <skill> [--yes]
    • transfer cancel <skill> [--yes]
  • エンドポイント:
    • POST /api/v1/skills/{slug}/transfer
    • POST /api/v1/skills/{slug}/transfer/accept
    • POST /api/v1/skills/{slug}/transfer/reject
    • POST /api/v1/skills/{slug}/transfer/cancel
    • GET /api/v1/transfers/incoming
    • GET /api/v1/transfers/outgoing

package explore [query...]

  • GET /api/v1/packagesGET /api/v1/packages/search を介して、統合パッケージカタログを閲覧または検索します。
  • これは Plugin やその他のパッケージファミリー項目に使用します。トップレベルの search は引き続きスキル検索サーフェスです。
  • フラグ:
    • --family skill|code-plugin|bundle-plugin
    • --official
    • --executes-code
    • --target <target>, --os <os>, --arch <arch>, --libc <libc>
    • --requires-browser, --requires-desktop, --requires-native-deps
    • --requires-external-service, --external-service <name>
    • --binary <name>, --os-permission <name>
    • --artifact-kind legacy-zip|npm-pack
    • --npm-mirror
    • --limit <n>(1-100、デフォルト: 25)
    • --json

例:

bash
clawhub package explore --family code-pluginclawhub package explore --family code-plugin --os darwin --requires-desktopclawhub package explore --family code-plugin --artifact-kind npm-packclawhub package explore --npm-mirrorclawhub package explore episodic-claw --family code-plugin

package inspect <name>

  • インストールせずにパッケージメタデータを取得します。
  • これは Plugin メタデータ、互換性、検証、ソース、バージョン/ファイル検査に使用します。
  • --version <version>: 特定のバージョンを検査します(デフォルト: latest)。
  • --tag <tag>: タグ付きバージョンを検査します(例: latest)。
  • --versions: バージョン履歴を一覧表示します(最初のページ)。
  • --limit <n>: 一覧表示する最大バージョン数(1-100)。
  • --files: 選択したバージョンのファイルを一覧表示します。
  • --file <path>: 生のファイル内容を取得します(テキストファイルのみ、200KB 制限)。
  • --json: 機械可読出力。

package download <name>

  • GET /api/v1/packages/{name}/versions/{version}/artifact を通じてパッケージバージョンを解決します。
  • リゾルバーの downloadUrl からアーティファクトをダウンロードします。
  • すべてのアーティファクトについて ClawHub SHA-256 を検証します。
  • ClawPack npm-pack アーティファクトでは、npm sha512 integrity、npm shasum、tarball の package.json name/version も検証します。
  • レガシー ZIP バージョンは、レガシー ZIP ルートを通じてダウンロードします。
  • フラグ:
    • --version <version>: 特定のバージョンをダウンロードします。
    • --tag <tag>: タグ付きバージョンをダウンロードします(デフォルト: latest)。
    • -o, --output <path>: 出力ファイルまたはディレクトリ。
    • --force: 既存の出力ファイルを上書きします。
    • --json: 機械可読出力。

例:

bash
clawhub package download @openclaw/example-plugin --tag latestclawhub package download @openclaw/example-plugin --version 1.2.3 -o artifacts/

package verify <file>

  • ローカルアーティファクトについて ClawHub SHA-256、npm sha512 integrity、npm shasum を計算します。
  • --package を指定すると、ClawHub から期待されるメタデータを解決し、ローカルファイルを公開済みアーティファクトメタデータと比較します。
  • 直接ダイジェストフラグを指定すると、ネットワーク検索なしで検証します。
  • フラグ:
    • --package <name>: 期待されるアーティファクトメタデータを解決するパッケージ名。
    • --version <version> または --tag <tag>: 期待されるパッケージバージョン。
    • --sha256 <hex>: 期待される ClawHub SHA-256。
    • --npm-integrity <sri>: 期待される npm integrity。
    • --npm-shasum <sha1>: 期待される npm shasum。
    • --json: 機械可読出力。

例:

bash
clawhub package verify ./example-plugin-1.2.3.tgz --package @openclaw/example-plugin --version 1.2.3clawhub package verify ./example-plugin-1.2.3.tgz --sha256 <hex>

package validate <source>

  • ローカル Plugin パッケージフォルダーに対して、ClawHub CLI にバンドルされた Plugin Inspector を実行します。
  • ローカル OpenClaw チェックアウトを探したりインポートしたりせず、デフォルトでオフライン/静的検証を行います。
  • 重大な互換性エラーでは非ゼロで終了します。警告のみの検出結果は出力されますが、終了コードはゼロです。
  • フラグ:
    • --out <dir>: Plugin Inspector レポートをこのディレクトリに書き込みます。
    • --openclaw <path>: 明示的なローカル OpenClaw チェックアウトに対して検査します。
    • --runtime: ランタイムキャプチャを有効にします。Plugin コードをインポートします。
    • --allow-execute: 分離されたワークスペースでのランタイムキャプチャを許可します。
    • --no-mock-sdk: ランタイムキャプチャ中のモック OpenClaw SDK を無効化します。
    • --json: 機械可読出力。

例:

bash
clawhub package validate ./example-plugin

検証でパッケージ、マニフェスト、SDK インポート、またはアーティファクトに関する検出結果が報告された場合は、Plugin 検証の修正を参照してから、コマンドを再実行してください。

package delete <name>

  • --version なしでは、パッケージとすべてのリリースをソフト削除します。
  • --version <version> は、fail-closed のバージョン固有ルートを通じて、所有する非最新リリース 1 つを完全に削除します。 削除されたバージョンは復元または再公開できません。現在の最新バージョンを削除する前に、代替を公開してください。このバージョン限定フローには、パッケージ所有者または org パブリッシャー管理者が必要です。プラットフォームスタッフはパッケージ所有権を迂回しません。
  • パッケージ全体のソフト削除には、パッケージ所有者、org パブリッシャーの所有者/管理者、プラットフォームモデレーター、またはプラットフォーム管理者が必要です。
  • フラグ:
    • --version <version>: 非最新バージョン 1 つを完全に削除します。
    • --yes: 確認をスキップします。
    • --json: 機械可読出力。

例:

bash
clawhub package delete @openclaw/example-plugin --yesclawhub package delete @openclaw/example-plugin --version 1.2.3 --yes

package undelete <name>

  • ソフト削除されたパッケージとリリースを復元します。
  • バージョンの削除取り消しはありません。完全に削除されたバージョンは復元できません。
  • パッケージ所有者、org パブリッシャーの所有者/管理者、プラットフォームモデレーター、またはプラットフォーム管理者が必要です。
  • POST /api/v1/packages/{name}/undelete を呼び出します。
  • フラグ:
    • --yes: 確認をスキップします。
    • --json: 機械可読出力。

例:

bash
clawhub package undelete @openclaw/example-plugin --yes

package transfer <name>

  • パッケージを別のパブリッシャーに移譲します。
  • プラットフォーム管理者が実行する場合を除き、現在のパッケージ所有者と移譲先パブリッシャーの両方に対する管理者アクセス権が必要です。
  • スコープ付きパッケージ名は、一致するスコープ所有者に移譲する必要があります。
  • POST /api/v1/packages/{name}/transfer を呼び出します。
  • フラグ:
    • --to <owner>: 移譲先パブリッシャーハンドル。
    • --reason <text>: 任意の監査理由。
    • --json: 機械可読出力。

例:

bash
clawhub package transfer @openclaw/example-plugin --to openclaw

package report

  • パッケージをモデレーターに報告するための認証済みコマンド。
  • POST /api/v1/packages/{name}/report を呼び出します。
  • 報告はパッケージレベルで、任意でバージョンに関連付けられ、レビューのためにモデレーターに表示されます。
  • 報告だけでパッケージが自動的に非表示になったり、ダウンロードがブロックされたりすることはありません。
  • フラグ:
    • --version <version>: 報告に添付する任意のパッケージバージョン。
    • --reason <text>: 必須の報告理由。
    • --json: 機械可読出力。

例:

bash
clawhub package report @openclaw/example-plugin --version 1.2.3 --reason "suspicious native payload"

package moderation-status

  • パッケージのモデレーション表示状態を確認する所有者向けコマンド。
  • GET /api/v1/packages/{name}/moderation を呼び出します。
  • 現在のパッケージスキャン状態、未解決の報告数、最新リリースの手動モデレーション状態、ダウンロードブロック状態、モデレーション理由を表示します。
  • フラグ:
    • --json: 機械可読出力。

例:

bash
clawhub package moderation-status @openclaw/example-plugin

package readiness <name>

  • パッケージが将来の OpenClaw 利用に対応できる状態かどうかを確認します。
  • GET /api/v1/packages/{name}/readiness を呼び出します。
  • 公式ステータス、ClawPack の可用性、アーティファクトダイジェスト、ソース来歴、OpenClaw 互換性、ホストターゲット、環境メタデータ、スキャン状態に関するブロッカーを報告します。
  • フラグ:
    • --json: 機械可読出力。

例:

bash
clawhub package readiness @openclaw/example-plugin

package migration-status <name>

  • バンドルされた OpenClaw Plugin を置き換える可能性があるパッケージについて、オペレーター向けの移行ステータスを表示します。
  • package readiness と同じ計算済み readiness エンドポイントを呼び出しますが、移行に重点を置いたステータス、最新バージョン、公式パッケージ状態、チェック、ブロッカーを出力します。
  • フラグ:
    • --json: 機械可読出力。

例:

bash
clawhub package migration-status @openclaw/example-plugin

publisher create <handle>

  • 認証済みユーザーが所有する org パブリッシャーを作成します。
  • ハンドルは小文字に正規化され、@ 付きでもなしでも渡せます。
  • 新しく作成された org パブリッシャーは、デフォルトでは信頼済み/公式ではありません。
  • 既存のパブリッシャー、ユーザー、または予約済みルートによってハンドルがすでに使用されている場合は失敗します。
bash
clawhub publisher create opik --display-name "Opik"

package publish <source>

  • POST /api/v1/packages を介してコード Plugin またはバンドル Plugin を公開します。
  • <source> は次を受け付けます:
    • ローカルフォルダーのパス: ./my-plugin
    • ローカル ClawPack npm-pack tarball: ./my-plugin-1.2.3.tgz
    • GitHub リポジトリ: owner/repo または owner/repo@ref
    • GitHub URL: https://github.com/owner/repo
  • メタデータは package.jsonopenclaw.plugin.json、および .codex-plugin/plugin.json.claude-plugin/plugin.json.cursor-plugin/plugin.json などの実際の OpenClaw バンドルマーカーから自動検出されます。
  • .tgz ソースは ClawPack として扱われます。CLI は正確な npm-pack バイトをアップロードし、抽出した package/ の内容は検証と メタデータの事前入力にのみ使用します。
  • コード Plugin フォルダーは、アップロード前に ClawPack npm tarball にパックされるため、 OpenClaw インストールは正確な成果物を検証できます。バンドル Plugin フォルダーは引き続き 抽出ファイルの公開パスを使用します。
  • GitHub ソースでは、ソース帰属情報がリポジトリ、解決済みコミット、ref、サブパスから自動入力されます。
  • ローカルフォルダーでは、origin リモートが GitHub を指している場合、ソース帰属情報がローカル git から自動検出されます。
  • 外部コード Plugin は openclaw.compat.pluginApiopenclaw.build.openclawVersion を明示的に宣言する必要があります。 トップレベルの package.json.version は公開検証のフォールバックとして使用されません。
  • --dry-run は、アップロードせずに解決済みの公開ペイロードをプレビューします。
  • --json は CI 向けに機械可読な出力を生成します。
  • --owner <handle> は、アクターにパブリッシャーアクセスがある場合、ユーザーまたは組織のパブリッシャーハンドルで公開します。
  • スコープ付きパッケージ名は選択した所有者と一致する必要があります。docs/publishing.md を参照してください。
  • 既存のフラグ (--family--name--version--source-repo--source-commit--source-ref--source-path) は引き続き上書きとして機能します。
  • プライベート GitHub リポジトリには GITHUB_TOKEN が必要です。
bash
clawhub package publish ./plugin.tgz --owner openclaw

推奨ローカルフロー

ライブリリースを作成する前に、解決済みパッケージメタデータと ソース帰属情報を確認できるよう、まず --dry-run を使用してください:

bash
npm packclawhub package publish ./my-plugin-1.2.3.tgz --family code-plugin --dry-runclawhub package publish ./my-plugin-1.2.3.tgz --family code-plugin

ローカルフォルダーフロー

コード Plugin では、フォルダー公開によりパッケージフォルダーから ClawPack 成果物が ビルドされ、アップロードされます:

bash
clawhub package publish ./my-plugin --family code-plugin --dry-runclawhub package publish ./my-plugin --family code-plugin

--family code-plugin 用の最小 package.json

外部コード Plugin には、package.json に少量の OpenClaw メタデータが 必要です。この最小マニフェストで公開を成功させるには十分です:

json
{  "name": "@myorg/openclaw-my-plugin",  "version": "1.0.0",  "type": "module",  "openclaw": {    "extensions": ["./index.ts"],    "compat": {      "pluginApi": ">=2026.3.24-beta.2"    },    "build": {      "openclawVersion": "2026.3.24-beta.2"    }  }}

必須フィールド:

  • openclaw.compat.pluginApi
  • openclaw.build.openclawVersion

注記:

  • package.json.version はパッケージのリリースバージョンですが、 OpenClaw の互換性/ビルド検証のフォールバックとしては使用されません。
  • openclaw.hostTargetsopenclaw.environment は任意のメタデータです。 ClawHub は存在する場合に表示することがありますが、公開には必須ではありません。
  • より詳細な互換性メタデータを公開したい場合、openclaw.compat.minGatewayVersionopenclaw.build.pluginSdkVersion は任意の追加項目です。
  • 古い clawhub CLI リリースを使用している場合は、アップロード前に ローカルの事前チェックが実行されるよう、公開前にアップグレードしてください。
  • 検証で修復コードが報告された場合は、 Plugin 検証の修正を参照してください。

GitHub Actions

ClawHub は Plugin リポジトリ向けに、公式の再利用可能ワークフローも /.github/workflows/package-publish.yml で提供しています。

一般的な呼び出し元の設定:

yaml
name: Package Publish on:  pull_request:  workflow_dispatch:  push:    tags:      - "v*" jobs:  dry-run:    if: github.event_name == 'pull_request'    uses: openclaw/clawhub/.github/workflows/package-publish.yml@v0.12.0    with:      dry_run: true   publish:    if: github.event_name == 'workflow_dispatch' || startsWith(github.ref, 'refs/tags/')    permissions:      contents: read      id-token: write    uses: openclaw/clawhub/.github/workflows/package-publish.yml@v0.12.0    with:      dry_run: false    secrets:      clawhub_token: ${{ secrets.CLAWHUB_TOKEN }}

注記:

  • 再利用可能ワークフローは、既定で source を呼び出し元リポジトリに設定します。
  • モノレポでは、ワークフローが Plugin パッケージフォルダーを公開するように source_path を渡してください。例: source_path: extensions/codex
  • 再利用可能ワークフローは安定タグまたは完全なコミット SHA に固定してください。@main からリリース公開を実行しないでください。
  • pull_request では、CI を汚染しないよう dry_run: true を使用してください。
  • 実際の公開は、workflow_dispatch やタグ push など信頼されたイベントに限定してください。
  • シークレットなしの信頼済み公開は workflow_dispatch でのみ機能します。タグ push には引き続き clawhub_token が必要です。
  • 初回公開、信頼されていないパッケージ、または緊急公開のために clawhub_token を利用可能にしておいてください。
  • ワークフローは JSON 結果を成果物としてアップロードし、ワークフロー出力として公開します。

package trusted-publisher get <name>

  • パッケージの GitHub Actions 信頼済みパブリッシャー設定を表示します。
  • 設定後にこれを使用して、リポジトリ、ワークフローファイル名、 任意の環境固定を確認します。
  • フラグ:
    • --json: 機械可読な出力。

例:

bash
clawhub package trusted-publisher get @openclaw/example-plugin

package trusted-publisher set <name>

  • 既存パッケージに GitHub Actions 信頼済みパブリッシャー設定を 添付または置換します。
  • パッケージは通常の手動またはトークン認証済みの clawhub package publish を通じて先に作成されている必要があります。
  • 設定後、今後サポート対象の GitHub Actions 公開では、長期有効な ClawHub トークンなしで OIDC/信頼済み公開を使用できます。
  • --repository <repo>owner/repo である必要があります。
  • --workflow-filename <file>.github/workflows/ 内の ワークフローファイル名と一致する必要があります。
  • --environment <name> は任意です。設定した場合、OIDC クレーム内の GitHub Actions 環境が完全一致する必要があります。
  • ClawHub はこのコマンドの実行時に、設定された GitHub リポジトリを検証します。 パブリックリポジトリは公開 GitHub メタデータを通じて検証できます。プライベート リポジトリでは、将来の ClawHub GitHub App インストールや別の認可済み GitHub 連携などを通じて、ClawHub がそのリポジトリへの GitHub アクセスを持つ必要があります。
  • フラグ:
    • --repository <repo>: GitHub リポジトリ。例: openclaw/example-plugin
    • --workflow-filename <file>: ワークフローファイル名。例: package-publish.yml
    • --environment <name>: 任意の完全一致 GitHub Actions 環境。
    • --json: 機械可読な出力。

例:

bash
clawhub package trusted-publisher set @openclaw/example-plugin \  --repository openclaw/example-plugin \  --workflow-filename package-publish.yml \  --environment release

package trusted-publisher delete <name>

  • パッケージから信頼済みパブリッシャー設定を削除します。
  • ワークフロー、リポジトリ、または環境固定を無効化または再作成する必要がある場合、 ロールバックとして使用します。
  • 今後の実際の公開は、設定が再度行われるまで通常の認証済み公開を使用する必要があります。
  • フラグ:
    • --json: 機械可読な出力。

例:

bash
clawhub package trusted-publisher delete @openclaw/example-plugin

インストールテレメトリ

  • ログイン済みの場合、CLAWHUB_DISABLE_TELEMETRY=1 が設定されていない限り、 clawhub install <slug> の後に送信されます。
  • レポートはベストエフォートです。テレメトリが利用できない場合でも、 インストールコマンドは失敗しません。
  • 詳細: docs/telemetry.md
Was this useful?
On this page

On this page