Skip to main content
リファレンス

プラグインリファレンス

plugin.json のフィールド、ディレクトリ構成、および Marketplace Schema のフィールドレベルのリファレンス。使用ガイドについてはプラグインページを参照してください。

プラグインはインストール可能な拡張パッケージであり、Qoder CLI にコマンド、エージェント、スキル、フック、出力スタイル、ワークフロー、および MCP サーバーを追加します。本ページは、プラグインマニフェスト、ディレクトリ構造、およびマーケットプレイスのスキーマに関する完全なリファレンスです。利用ガイドについてはプラグインを参照してください。

プラグインマニフェスト(plugin.json)

マニフェストファイルは .qoder-plugin/plugin.json に配置し、プラグインのルートディレクトリには配置しません。このファイルは省略可能です。宣言されていない場合、CLI は規約に基づくディレクトリからコンポーネントを読み込み、プラグインのディレクトリ名をプラグイン名として使用します。安定した nameversion などのメタ情報を得るために、宣言することをお勧めします。

必須フィールド

plugin.json のうち必須なのは name のみで、その他のフィールドはすべて省略可能です。
フィールド説明
namestringプラグインの一意な識別子(ケバブケース、スペースなし)。

オプションのメタ情報フィールド

フィールド説明
versionstringセマンティックバージョン(例:1.0.0)。
displayNamestringUI に表示される読みやすい名称。
descriptionstring短い説明。
authorobject著者情報(name/email/url)。
homepagestringドキュメントまたはホームページの URL。
repositorystringソースコードリポジトリの URL。
licensestringSPDX ライセンス識別子(例:MITApache-2.0)。
keywordsstring[]検索および分類用のタグ。
dependenciesarray依存する他のプラグイン(マーケットプレイスを指定可能)。

コンポーネント宣言フィールド

以下のフィールドは、規約に基づくディレクトリを上書きするか、コンポーネントをインラインで宣言するために使用します(相対パスの文字列、配列、またはオブジェクトマッピング):
フィールド説明
commandsコマンド定義。
agentsエージェント定義ファイルのパス。
skillsスキルディレクトリのパス。
outputStyles出力スタイル定義。
workflowsPath / workflowsPathsワークフローファイルのパス。
hooksフック構成(相対パスの JSON ファイルまたはインライン構成)。
mcpServersMCP サーバー構成(相対パスの JSON ファイルまたはインライン構成)。
userConfigユーザーが構成可能なオプションの定義。
settingsプラグイン有効時にマージされる構成。現在は agent キーのみがサポートされ、その他のキーは無視されます。

規約に基づくディレクトリ構造

マニフェストでコンポーネントが明示的に宣言されていない場合、プラグインは以下の規約に基づくディレクトリから自動的に検出されます:
plugin-name/
├── .qoder-plugin/
│   └── plugin.json      # 推奨:manifest(省略可)
├── commands/            # コマンド定義(.md)
│   └── subdir/          # ネストディレクトリに対応
├── agents/              # エージェント定義(.md)
├── skills/              # スキルディレクトリ
│   └── skill-name/
│       └── SKILL.md
├── hooks/
│   └── hooks.json       # フック設定
├── output-styles/       # 出力スタイル定義
├── workflows/           # ワークフロー定義
├── bin/                 # 実行ファイル(PATH に追加)
└── .mcp.json            # MCP サーバー設定
.mcp.json のフォールバックとして、mcp.json(先頭のドットなし)にも対応しています。両方が存在する場合は .mcp.json が優先され、マージは行われません。

マーケットプレイスマニフェスト(marketplace.json)

プラグインマーケットプレイスは、marketplace.json を通じてインストール可能なプラグインのセットを記述します。

必須フィールド

フィールド説明
namestringマーケットプレイス名。
ownerobjectマーケットプレイスメンテナー情報(name/email/url)。
pluginsarrayプラグインエントリの配列。

オプションフィールド

フィールド説明
forceRemoveDeletedPluginsbooleanマーケットプレイスから削除されたプラグインを自動的にアンインストールします。
metadata.pluginRootstringプラグインソースへの相対ベースパス。
metadata.versionstringマーケットプレイスのバージョン。
metadata.descriptionstringマーケットプレイスの説明。
allowCrossMarketplaceDependenciesOnstring[]マーケットプレイス間の依存を許可するマーケットプレイス名。

プラグインエントリフィールド

フィールド説明
namestringプラグイン名(plugin.json 内の name と一致する必要があります)。
sourcestring/objectプラグインのソース(相対パス、npm、git、github、url など)。
categorystring分類タグ。
tagsstring[]検索タグ。
strictbooleanプラグインフォルダー内にマニフェストが存在することを要求するかどうか(デフォルトは true)。

管理コマンド

インタラクティブセッションでは /plugins(エイリアス /plugin)を使用します。サブコマンドなしで実行すると、プラグインエクスプローラーが開きます:
サブコマンド引数説明
install(エイリアス i<plugin>プラグインをインストールします。
uninstall(エイリアス remove/rm<plugin>プラグインをアンインストールします。
enable<plugin>プラグインを有効にします。
disable<plugin>プラグインを無効にします。
update*<plugin>プラグインを更新します。
validate<path>プラグインディレクトリまたは plugin.json を検証します。
marketplace(エイリアス market)*add <source>listremove <name>update [name] を含むプラグインマーケットプレイスを管理します。
reloadすべてのプラグインを再読み込みします。
コマンドラインでは qoder plugins(エイリアス plugin)を使用します:
サブコマンド説明
listインストール済みのプラグインを一覧表示します。
install(エイリアス iマーケットプレイスまたはローカルディレクトリからプラグインをインストールします。
uninstall(エイリアス remove/rmプラグインをアンインストールします。
enable / disableプラグインを有効/無効にします。
update*ソースマーケットプレイスからプラグインを最新バージョンに更新します。
validateローカルディレクトリ内のプラグインを検証します。
marketplace(エイリアス mp)*プラグインマーケットプレイスを管理します。
* 印の付いたコマンドはプラグインマーケットプレイスのフィーチャーフラグによって制御されており、有効化されていない場合は使用できません。 起動パラメーター:--plugin-dir <path> 追加のプラグイン検索ディレクトリ。

セキュリティ

これら 2 項目は settings.jsonsecurity グループ下に記述します(変更後は再起動が必要です):
{
  "security": {
    "blockGitExtensions": true,
    "allowedExtensions": ["^https://github\\.com/my-org/"]
  }
}
  • security.blockGitExtensions: true は Git からのプラグインのインストール/読み込みをブロックできます。
  • security.allowedExtensions はプラグインソースの正規表現による許可リストを提供し、空でない場合は一致するソースのみを許可します(blockGitExtensions を上書きします)。

次のステップ

Qoder CLI を使用する
プラグインリファレンス - Qoder