godot-cli リファレンス

godot-cli は Godot MCP 用のコマンドラインツールで、npm で公開されています。アドオンをインストールし、サインインし、AI エージェントの設定を書き込み、適切な接続設定でエディタをビルドして開き、スクリプトからツールを呼び出します。このページでは godot-cli 0.34.0 のすべてのコマンドとそのフラグを一覧します。

インストールと基本#

npm install -g godot-cli
godot-cli --help
godot-cli <command> --help

Node.js ^20.19.0 または >=22.12.0 が必要で、Windows、macOS、Linux で動作します。インストールせずに任意のコマンドを実行することもできます: npx godot-cli <command>。

ほとんどのコマンドはプロジェクトフォルダを省略可能な位置引数 [path]（または --path <path>）として受け取り、デフォルトは現在のフォルダです。すべてのコマンドは診断出力用に -v / --verbose を受け付けます。

コマンド一覧#

install-plugin#

godot_mcp アドオンを一通りインストールします: GitHub からアドオンのリリースをダウンロード（またはローカルのものをコピー）し、.csproj に NuGet の PackageReference と拡張機能カタログの <EmbeddedResource> を追加し、EnableDynamicLoading を設定し、project.godot でプラグインを有効化します。再実行しても安全です。

godot-cli install-plugin ./MyGodotProject
godot-cli install-plugin --version 0.34.0 ./MyGodotProject
godot-cli install-plugin --source ./Godot-MCP/addons/godot_mcp ./MyGodotProject

install-extension#

godot-cli install-extension <id> [path] は拡張機能カタログで id（パッケージ id または名前）を解決し、その <PackageReference> を追加または更新します。--version <x.y.z> を指定すると、最新の安定版ではなく正確なバージョンを要求します。その後 godot-cli build を実行してください。詳しくは Extensions を参照してください。

remove-plugin#

project.godot の [editor_plugins] セクションでアドオンを無効化します。addons/godot_mcp/ や .csproj のエントリは削除しません。

create-project#

最小限の Godot 4 プロジェクト（project.godot と icon.svg）を生成します。既存の Godot、Unity、Unreal プロジェクトは上書きしません。

build#

プロジェクトの .csproj に対して dotnet build を実行し、次回エディタを開いたときにアドオンが読み込まれるようにします。.csproj がないプロジェクトはスキップされます。

open#

C# アセンブリをビルドし、Godot エディタを見つけてプロジェクトを開きます。ビルドが失敗した場合、エディタは起動しません。エディタは次の順序で検索されます: --editor-path、GODOT_BIN または GODOT4_BIN 環境変数、PATH 上の Godot バイナリ（Windows では .NET ビルドが優先されます）、そして一般的なインストールフォルダ。

close#

プロジェクトで実行中の Godot エディターを安全に停止します。

exec#

script-execute ツールを使ってプロジェクトのエディターで C# を実行します。コードは単純な文の並びで、最後の式が結果になります。プロジェクトのエディターが実行中であれば再利用されます (自分のエディターが Custom モードで、ローカルサーバーが起動している必要があります)。そうでない場合、exec はプロジェクトをビルドし、ローカルサーバーに接続したヘッドレスエディターを起動します。このエディターは呼び出しがないまま --idle 秒経過すると終了します (既定は 300)。

godot-cli exec '1 + 2' --path ./MyGodotProject
godot-cli exec -f snippet.cs --using MyGame.Gameplay
godot-cli exec 'Helper.Twice(21)' --include helpers

コンパイルエラーはスニペットの行を指し示し、コード 1 で終了します。

login#

OAuth 2.1 デバイスフローで ai-game.dev にサインインし、認証情報を ~/.ai-game-dev/credentials.json に保存します。エディターはこのファイルを読み取ります。詳細は AI クライアントの接続 を参照してください。

setup-mcp#

godot-cli setup-mcp <agent> [path] はエージェントの MCP 設定を書き込み、既定ではこのプロジェクトに固定します。エージェント ID と設定ファイルは AI クライアントの接続 に記載されています。

setup-skills#

godot-cli setup-skills <agent> [path] はアドオンのツールファミリーごとの SKILL.md ファイルをエージェントのスキルフォルダー (たとえば .claude/skills) に書き込みます。実行中のエディターは不要です。--list で各エージェントのスキル対応状況を表示します。

configure#

MCP クライアントに表示されるツール、プロンプト、リソースを .godot-mcp/features.json で一覧表示または変更します。非表示の項目も名前で呼び出せば実行されます。

run-tool と run-system-tool#

サーバーの HTTP API 経由でツールを直接呼び出します: run-tool は /api/tools/<tool> に、run-system-tool は /api/system-tools/<tool> に POST します（ping など、MCP クライアントから隠されているツール向け）。

godot-cli run-tool rql-query ./MyGodotProject --input '{"query":"nodes | select name class"}'
godot-cli run-system-tool ping ./MyGodotProject

--url を指定しない場合、サーバーは GODOT_MCP_HOST、次に GODOT_MCP_CLOUD_URL、次に GODOT_MCP_CONNECTION_MODE=Cloud のときはクラウド、次にプロジェクトに登録済みのサーバー、最後にプロジェクトのローカルポートの順に選択されます。

status と wait-for-ready#

status はプロジェクトで実行中のエディタを検出し、サーバーをプローブします（--url、--token、--timeout <ms>、デフォルト 5000）。wait-for-ready はエディタが応答するまで ping をポーリングします（--url、--token、--timeout <ms> デフォルト 120000、--interval <ms> デフォルト 3000）。open の後のスクリプトで使用します。

update#

godot-cli update は npm で新しい godot-cli を確認してインストールします。--check はレポートのみ行います。

関連情報#

• AI Game Dev アプリには独自の gamedev CLI があります: App CLI。
• Unity と Unreal には unity-mcp-cli と unreal-mcp-cli があります: Unity MCP と Unreal MCP の wiki を参照してください。