godot-cli 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,25 +1,25 @@
-# Changelog
-
-All notable changes to `godot-cli` are documented in this file.
-
-## 0.1.0
-
-Initial release. A cross-platform CLI for Godot-MCP, mirroring `unity-mcp-cli`'s feature set and structure,
-adapted for Godot.
-
-- `open` — resolve the Godot editor binary (`GODOT_BIN`/`GODOT4_BIN` → PATH → per-OS common dirs) and
-  launch `--editor --path <project>` with the `GODOT_MCP_*` connection env vars.
-- `run-tool` / `run-system-tool` — POST to `<url>/api/tools/<name>` and `<url>/api/system-tools/<name>`.
-- `status` — detect a running Godot editor and probe MCP-server health.
-- `wait-for-ready` — poll the server until it answers `ping`.
-- `setup-mcp` — write an AI-agent MCP-client config (claude-code, claude-desktop, cursor, vscode, custom)
-  pointing at the Godot server's `<host>/mcp` URL.
-- `configure` — list / enable / disable tools, prompts, and resources in the project-local
-  `.godot-mcp/features.json`.
-- `close` — gracefully terminate the Godot editor for a project (`--force` to hard-kill).
-- `install-plugin` / `remove-plugin` — enable/disable the `godot_mcp` addon in `project.godot`
-  `[editor_plugins]`.
-- `update` — check npm for a newer version and install it.
-
-`setup-skills` is intentionally not ported: Godot skills are generated addon-side by the McpPlugin engine,
-and the Godot MCP server exposes no skill-generate HTTP endpoint.
+# Changelog
+
+All notable changes to `godot-cli` are documented in this file.
+
+## 0.1.0
+
+Initial release. A cross-platform CLI for Godot-MCP, mirroring `unity-mcp-cli`'s feature set and structure,
+adapted for Godot.
+
+- `open` — resolve the Godot editor binary (`GODOT_BIN`/`GODOT4_BIN` → PATH → per-OS common dirs) and
+  launch `--editor --path <project>` with the `GODOT_MCP_*` connection env vars.
+- `run-tool` / `run-system-tool` — POST to `<url>/api/tools/<name>` and `<url>/api/system-tools/<name>`.
+- `status` — detect a running Godot editor and probe MCP-server health.
+- `wait-for-ready` — poll the server until it answers `ping`.
+- `setup-mcp` — write an AI-agent MCP-client config (claude-code, claude-desktop, cursor, vscode, custom)
+  pointing at the Godot server's `<host>/mcp` URL.
+- `configure` — list / enable / disable tools, prompts, and resources in the project-local
+  `.godot-mcp/features.json`.
+- `close` — gracefully terminate the Godot editor for a project (`--force` to hard-kill).
+- `install-plugin` / `remove-plugin` — enable/disable the `godot_mcp` addon in `project.godot`
+  `[editor_plugins]`.
+- `update` — check npm for a newer version and install it.
+
+`setup-skills` is intentionally not ported: Godot skills are generated addon-side by the McpPlugin engine,
+and the Godot MCP server exposes no skill-generate HTTP endpoint.

package/README.md

@@ -1,101 +1,101 @@
-# godot-cli
-
-Cross-platform CLI for **Godot-MCP** — the [Godot](https://godotengine.org/) editor addon that bridges
-LLMs (Claude, Cursor, Copilot, …) with the Godot editor via the
-[Model Context Protocol](https://modelcontextprotocol.io/).
-
-The CLI is the Godot analog of [`unity-mcp-cli`](https://www.npmjs.com/package/unity-mcp-cli): it resolves
-and launches the Godot editor with the right `GODOT_MCP_*` connection environment variables, runs MCP and
-system tools over the server's HTTP API, probes server health, writes AI-agent MCP-client config, and
-enables/disables the `godot_mcp` addon in a project.
-
-> **Licensed under Apache-2.0.**
-
-## Install
-
-```bash
-npm install -g godot-cli
-# or run ad-hoc:
-npx godot-cli <command>
-```
-
-Requires Node `^20.19.0 || >=22.12.0`.
-
-## Commands
-
-| Command | What it does |
-| --- | --- |
-| `open [path]` | Resolve the Godot editor binary and launch `--editor --path <project>` with `GODOT_MCP_*` connection env vars. |
-| `run-tool <tool> [path]` | POST to `<url>/api/tools/<tool>` with JSON input. |
-| `run-system-tool <tool> [path]` | POST to `<url>/api/system-tools/<tool>` (tools not exposed to MCP clients). |
-| `status [path]` | Detect a running Godot editor for the project and probe MCP-server health. |
-| `wait-for-ready [path]` | Poll the MCP server until it answers `ping`. |
-| `setup-mcp <agent> [path]` | Write the agent's MCP-client config pointing at the Godot server's `<host>/mcp` URL. |
-| `configure [path]` | List / enable / disable tools, prompts, and resources in the project-local `.godot-mcp/features.json`. |
-| `close [path]` | Gracefully stop the Godot editor running for a project (`--force` to hard-kill). |
-| `install-plugin [path]` | Enable the `godot_mcp` addon in `project.godot` `[editor_plugins]`. |
-| `remove-plugin [path]` | Disable the `godot_mcp` addon in `project.godot` `[editor_plugins]`. |
-| `update` | Check npm for a newer `godot-cli` and install it. |
-
-### Editor resolution (`open`)
-
-`open` locates the Godot editor binary in this order:
-
-1. `--editor-path <path>` (explicit).
-2. `GODOT_BIN` / `GODOT4_BIN` environment variables.
-3. The first matching Godot binary on `PATH` (the mono build is preferred on Windows).
-4. Per-OS common install directories — Windows prefers the mono build; macOS resolves the
-   `.app/Contents/MacOS/Godot` binary; Linux scans common extracted-binary locations.
-
-### Connection env vars
-
-`open` forwards these to the editor process (names match the addon's `GodotMcpConfig`):
-
-| Flag | Env var |
-| --- | --- |
-| `--url <host>` | `GODOT_MCP_HOST` |
-| `--cloud-url <url>` | `GODOT_MCP_CLOUD_URL` |
-| `--token <token>` | `GODOT_MCP_TOKEN` |
-| `--auth None\|Required` | `GODOT_MCP_AUTH_OPTION` |
-| `--mode Cloud\|Custom` | `GODOT_MCP_CONNECTION_MODE` |
-| `--log-level <level>` | `GODOT_MCP_LOG_LEVEL` |
-
-### Server URL resolution (`run-tool` / `status` / `wait-for-ready`)
-
-Unlike Unity, the Godot plugin is a **server-less client** whose persisted config lives in `user://`
-(outside the project tree), so there is no deterministic project-path → port hash. The server base URL is
-resolved as:
-
-1. `--url <url>` (explicit override).
-2. `GODOT_MCP_HOST` env (Custom-mode host).
-3. `GODOT_MCP_CLOUD_URL` env / Cloud mode → cloud base (`https://ai-game.dev`).
-4. Default custom host (`http://localhost:8080`).
-
-Pass `--url http://localhost:<port>` to target a local/self-hosted server.
-
-## `setup-skills` is not in v1
-
-Unlike the Unity CLI, there is **no `setup-skills` command**. Godot skills are generated **addon-side** by
-the McpPlugin engine on plugin boot (`GodotMcpConnection.Start` → `GenerateSkillFilesIfNeeded`, driven by
-the `GodotMcpConfig.GenerateSkillFiles` toggle, with a manual "Generate" button in the dock's Skills card).
-The Godot MCP server exposes **no** `skill-generate` HTTP endpoint for the CLI to call, so porting
-`setup-skills` would have nothing to invoke. It is intentionally out of scope for v1.
-
-## Library API
-
-The package also exports a side-effect-free library (the `.` entry):
-
-```ts
-import { openProject, runTool, setupMcp, installPlugin } from 'godot-cli';
-```
-
-Every function returns a discriminated union (`{ kind: 'success', ... }` / `{ kind: 'failure', error }`)
-and never throws past the public boundary.
-
-## Development
-
-```bash
-npm install
-npm run build   # tsc → dist/ (ESM)
-npm test        # vitest
-```
+# godot-cli
+
+Cross-platform CLI for **Godot-MCP** — the [Godot](https://godotengine.org/) editor addon that bridges
+LLMs (Claude, Cursor, Copilot, …) with the Godot editor via the
+[Model Context Protocol](https://modelcontextprotocol.io/).
+
+The CLI is the Godot analog of [`unity-mcp-cli`](https://www.npmjs.com/package/unity-mcp-cli): it resolves
+and launches the Godot editor with the right `GODOT_MCP_*` connection environment variables, runs MCP and
+system tools over the server's HTTP API, probes server health, writes AI-agent MCP-client config, and
+enables/disables the `godot_mcp` addon in a project.
+
+> **Licensed under Apache-2.0.**
+
+## Install
+
+```bash
+npm install -g godot-cli
+# or run ad-hoc:
+npx godot-cli <command>
+```
+
+Requires Node `^20.19.0 || >=22.12.0`.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `open [path]` | Resolve the Godot editor binary and launch `--editor --path <project>` with `GODOT_MCP_*` connection env vars. |
+| `run-tool <tool> [path]` | POST to `<url>/api/tools/<tool>` with JSON input. |
+| `run-system-tool <tool> [path]` | POST to `<url>/api/system-tools/<tool>` (tools not exposed to MCP clients). |
+| `status [path]` | Detect a running Godot editor for the project and probe MCP-server health. |
+| `wait-for-ready [path]` | Poll the MCP server until it answers `ping`. |
+| `setup-mcp <agent> [path]` | Write the agent's MCP-client config pointing at the Godot server's `<host>/mcp` URL. |
+| `configure [path]` | List / enable / disable tools, prompts, and resources in the project-local `.godot-mcp/features.json`. |
+| `close [path]` | Gracefully stop the Godot editor running for a project (`--force` to hard-kill). |
+| `install-plugin [path]` | Enable the `godot_mcp` addon in `project.godot` `[editor_plugins]`. |
+| `remove-plugin [path]` | Disable the `godot_mcp` addon in `project.godot` `[editor_plugins]`. |
+| `update` | Check npm for a newer `godot-cli` and install it. |
+
+### Editor resolution (`open`)
+
+`open` locates the Godot editor binary in this order:
+
+1. `--editor-path <path>` (explicit).
+2. `GODOT_BIN` / `GODOT4_BIN` environment variables.
+3. The first matching Godot binary on `PATH` (the mono build is preferred on Windows).
+4. Per-OS common install directories — Windows prefers the mono build; macOS resolves the
+   `.app/Contents/MacOS/Godot` binary; Linux scans common extracted-binary locations.
+
+### Connection env vars
+
+`open` forwards these to the editor process (names match the addon's `GodotMcpConfig`):
+
+| Flag | Env var |
+| --- | --- |
+| `--url <host>` | `GODOT_MCP_HOST` |
+| `--cloud-url <url>` | `GODOT_MCP_CLOUD_URL` |
+| `--token <token>` | `GODOT_MCP_TOKEN` |
+| `--auth None\|Required` | `GODOT_MCP_AUTH_OPTION` |
+| `--mode Cloud\|Custom` | `GODOT_MCP_CONNECTION_MODE` |
+| `--log-level <level>` | `GODOT_MCP_LOG_LEVEL` |
+
+### Server URL resolution (`run-tool` / `status` / `wait-for-ready`)
+
+Unlike Unity, the Godot plugin is a **server-less client** whose persisted config lives in `user://`
+(outside the project tree), so there is no deterministic project-path → port hash. The server base URL is
+resolved as:
+
+1. `--url <url>` (explicit override).
+2. `GODOT_MCP_HOST` env (Custom-mode host).
+3. `GODOT_MCP_CLOUD_URL` env / Cloud mode → cloud base (`https://ai-game.dev`).
+4. Default custom host (`http://localhost:8080`).
+
+Pass `--url http://localhost:<port>` to target a local/self-hosted server.
+
+## `setup-skills` is not in v1
+
+Unlike the Unity CLI, there is **no `setup-skills` command**. Godot skills are generated **addon-side** by
+the McpPlugin engine on plugin boot (`GodotMcpConnection.Start` → `GenerateSkillFilesIfNeeded`, driven by
+the `GodotMcpConfig.GenerateSkillFiles` toggle, with a manual "Generate" button in the dock's Skills card).
+The Godot MCP server exposes **no** `skill-generate` HTTP endpoint for the CLI to call, so porting
+`setup-skills` would have nothing to invoke. It is intentionally out of scope for v1.
+
+## Library API
+
+The package also exports a side-effect-free library (the `.` entry):
+
+```ts
+import { openProject, runTool, setupMcp, installPlugin } from 'godot-cli';
+```
+
+Every function returns a discriminated union (`{ kind: 'success', ... }` / `{ kind: 'failure', error }`)
+and never throws past the public boundary.
+
+## Development
+
+```bash
+npm install
+npm run build   # tsc → dist/ (ESM)
+npm test        # vitest
+```

package/bin/godot-cli.js

@@ -1,2 +1,2 @@
-#!/usr/bin/env node
-import '../dist/index.js';
+#!/usr/bin/env node
+import '../dist/index.js';

package/docs/README.md

@@ -1,7 +1,7 @@
-# godot-cli — docs
-
-Additional documentation for `godot-cli`. See the package [`README.md`](../README.md) for the full
-command reference and library API.
-
-Localized READMEs (e.g. `README.es.md`, `README.ja.md`, `README.zh-CN.md`) may be added here over time,
-mirroring the Unity-MCP CLI's translation set.
+# godot-cli — docs
+
+Additional documentation for `godot-cli`. See the package [`README.md`](../README.md) for the full
+command reference and library API.
+
+Localized READMEs (e.g. `README.es.md`, `README.ja.md`, `README.zh-CN.md`) may be added here over time,
+mirroring the Unity-MCP CLI's translation set.

package/package.json

@@ -1,73 +1,73 @@
-{
-  "name": "godot-cli",
-  "version": "0.1.0",
-  "description": "Cross-platform CLI tool for Godot-MCP (Skills & MCP). Resolves and launches the Godot editor with MCP connection env vars, runs MCP/system tools over HTTP, probes server health, configures AI agents (Claude Code, Cursor, VS Code, …), and enables/disables the godot_mcp addon. Works with Claude Code, Cursor, Copilot, and any MCP client.",
-  "type": "module",
-  "main": "dist/lib.js",
-  "types": "dist/lib.d.ts",
-  "exports": {
-    ".": {
-      "types": "./dist/lib.d.ts",
-      "import": "./dist/lib.js"
-    },
-    "./cli": {
-      "types": "./dist/cli.d.ts",
-      "import": "./dist/cli.js"
-    }
-  },
-  "bin": {
-    "godot-cli": "bin/godot-cli.js"
-  },
-  "files": [
-    "dist",
-    "bin",
-    "README.md",
-    "CHANGELOG.md",
-    "docs"
-  ],
-  "scripts": {
-    "build": "tsc",
-    "pretest": "npm run build",
-    "test": "vitest run",
-    "test:watch": "vitest",
-    "prepublishOnly": "npm run build",
-    "prepack": "npm run build"
-  },
-  "keywords": [
-    "cli",
-    "godot",
-    "godot ai",
-    "godot skills",
-    "godot mcp",
-    "ai skills",
-    "ai mcp",
-    "ai",
-    "mcp",
-    "model-context-protocol",
-    "gamedev",
-    "game-dev"
-  ],
-  "author": {
-    "name": "Ivan Murzak",
-    "url": "https://github.com/IvanMurzak"
-  },
-  "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/IvanMurzak/Godot-MCP.git",
-    "directory": "cli"
-  },
-  "engines": {
-    "node": "^20.19.0 || >=22.12.0"
-  },
-  "dependencies": {
-    "chalk": "^5.6.2",
-    "commander": "^13.1.0",
-    "yocto-spinner": "^1.1.0"
-  },
-  "devDependencies": {
-    "@types/node": "^22.15.0",
-    "typescript": "^5.8.0",
-    "vitest": "^3.1.0"
-  }
-}
+{
+  "name": "godot-cli",
+  "version": "0.2.0",
+  "description": "Cross-platform CLI tool for Godot-MCP (Skills & MCP). Resolves and launches the Godot editor with MCP connection env vars, runs MCP/system tools over HTTP, probes server health, configures AI agents (Claude Code, Cursor, VS Code, …), and enables/disables the godot_mcp addon. Works with Claude Code, Cursor, Copilot, and any MCP client.",
+  "type": "module",
+  "main": "dist/lib.js",
+  "types": "dist/lib.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/lib.d.ts",
+      "import": "./dist/lib.js"
+    },
+    "./cli": {
+      "types": "./dist/cli.d.ts",
+      "import": "./dist/cli.js"
+    }
+  },
+  "bin": {
+    "godot-cli": "bin/godot-cli.js"
+  },
+  "files": [
+    "dist",
+    "bin",
+    "README.md",
+    "CHANGELOG.md",
+    "docs"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "pretest": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build",
+    "prepack": "npm run build"
+  },
+  "keywords": [
+    "cli",
+    "godot",
+    "godot ai",
+    "godot skills",
+    "godot mcp",
+    "ai skills",
+    "ai mcp",
+    "ai",
+    "mcp",
+    "model-context-protocol",
+    "gamedev",
+    "game-dev"
+  ],
+  "author": {
+    "name": "Ivan Murzak",
+    "url": "https://github.com/IvanMurzak"
+  },
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/IvanMurzak/Godot-MCP.git",
+    "directory": "cli"
+  },
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^13.1.0",
+    "yocto-spinner": "^1.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.0",
+    "typescript": "^5.8.0",
+    "vitest": "^3.1.0"
+  }
+}