path-terminal-init 0.2.11 → 0.2.12

package/README.md

@@ -1,93 +1,93 @@
-# path-terminal-init
-
-One-line setup for the **Path Terminal SDK integration assistant**. It connects the
-user's AI coding agent (Claude Code or Cursor) to the Path MCP help server and installs
-the right **per-OS integration recipe** into their EPOS project. The agent then wires the
-Path SDK in — a backend switcher for the emulator (Wi-Fi/IP by default, or Bluetooth) and
-a real Verifone terminal — guided by the recipe and the MCP server's tools.
-
-**This repo is the single source of truth** for both the bootstrap CLI and the recipes.
-`Path-mcp-server` serves them (`/rules`, `/init.js`) from here — there are no duplicate copies.
-
-> **Tuning the install process?** It's a *pair* of repos, not just this one:
-> - **`Path-terminal-init`** (here) — the **recipes/rules** (`rules/**/*.mdc`) the agent follows + the CLI. Changes reach partners only after **`npm publish`** (version bump + 2FA).
-> - **`Path-mcp-server`** — the **code examples** the agent pulls (`get_code_example`) + MCP prompts/tools. Changes go live only after a **deploy to the box** (mcp.path2ai.tech).
->
-> A single behaviour change usually touches **both** (the rule says *what*, the MCP example gives the *code*) — tune one without the other and they drift. Then **update the Terminal Bible** (§12 Distribution & releases) so the docs stay current. Distribution/versioning specifics per platform live in the SDK repos.
-
-## Layout
-
-```
-src/cli.ts                                   the bootstrap program
-rules/
-  ios/path-integration.mdc                   iOS (Swift / SPM)
-  android/path-integration-android.mdc       Android (Kotlin / Gradle)
-  windows-11/path-integration-windows11.mdc  Windows 11 (WinUI 3 / .NET 10)
-  windows-10/path-integration-windows10.mdc  Windows 10 (WPF / .NET Framework 4.8)
-build.mjs                                    builds dist/cli.js + dist/init.js
-```
-
-## How a customer runs it
-
-**Every platform (published to npm) — run from the project root:**
-```bash
-npx path-terminal-init
-```
-Works on macOS, Linux and Windows (PowerShell or CMD). Needs Node installed. It
-auto-detects iOS / Android / Windows 11 (WinUI 3) / Windows 10 (WPF). Add `--agent cursor`
-for Cursor (default is Claude Code).
-
-> **Windows PowerShell:** on a fresh box plain `npx` fails with *"npx.ps1 cannot be loaded
-> because running scripts is disabled on this system"* — that's PowerShell's default
-> execution policy blocking Node's `.ps1` shim, not an install problem. Run the `.cmd`
-> shim instead (works under any policy, no admin, no config change):
->
-> ```powershell
-> npx.cmd path-terminal-init
-> ```
->
-> Or fix it once with `Set-ExecutionPolicy -Scope CurrentUser RemoteSigned`, after which
-> plain `npx` works. CMD is unaffected, and the no-npm alternative below runs `node.exe`
-> directly so it never hits the policy at all.
-
-**Alternative — fetch from the help server (no npm):**
-```bash
-# macOS / Linux:
-node <(curl -s https://mcp.path2ai.tech/init.js) --agent claude
-# Windows PowerShell:
-curl.exe -s https://mcp.path2ai.tech/init.js -o "$env:TEMP\path-init.js"; node "$env:TEMP\path-init.js" --agent claude
-```
-
-The CLI writes a `.mcp.json` (connecting the agent to `https://mcp.path2ai.tech`), adds the
-SDK dependency, and drops the matching recipe into `.cursor/rules/` and/or `CLAUDE.md`.
-
-## Develop locally
-
-```bash
-npm install
-npm run build      # → dist/cli.js (installable) + dist/init.js (standalone bundle)
-npm run typecheck
-node dist/cli.js --help
-```
-
-## Two artifacts, one source
-
-- `dist/cli.js` — the installable CLI. Reads recipes from the local `rules/<os>/` folder.
-- `dist/init.js` — a self-contained bundle for the `curl … | node` one-liner. It runs with
-  no local `rules/` folder, so it fetches the recipe from the server's `/rules` endpoint.
-
-`Path-mcp-server` serves `dist/init.js` at `/init.js` and the `rules/` files at `/rules*`.
-Its deploy copies them from this repo, so the server is never a stale duplicate.
-
-## Publishing updates to npm
-
-Published as **[`path-terminal-init`](https://www.npmjs.com/package/path-terminal-init)** (public).
-To ship a new version: bump `version` in `package.json`, then:
-
-```bash
-npm login                       # if not already logged in
-npm publish --access public     # prepublishOnly rebuilds dist/ first
-npm view path-terminal-init version
-```
-
-`npx path-terminal-init` always fetches the latest published version.
+# path-terminal-init
+
+One-line setup for the **Path Terminal SDK integration assistant**. It connects the
+user's AI coding agent (Claude Code or Cursor) to the Path MCP help server and installs
+the right **per-OS integration recipe** into their EPOS project. The agent then wires the
+Path SDK in — a backend switcher for the emulator (Wi-Fi/IP by default, or Bluetooth) and
+a real Verifone terminal — guided by the recipe and the MCP server's tools.
+
+**This repo is the single source of truth** for both the bootstrap CLI and the recipes.
+`Path-mcp-server` serves them (`/rules`, `/init.js`) from here — there are no duplicate copies.
+
+> **Tuning the install process?** It's a *pair* of repos, not just this one:
+> - **`Path-terminal-init`** (here) — the **recipes/rules** (`rules/**/*.mdc`) the agent follows + the CLI. Changes reach partners only after **`npm publish`** (version bump + 2FA).
+> - **`Path-mcp-server`** — the **code examples** the agent pulls (`get_code_example`) + MCP prompts/tools. Changes go live only after a **deploy to the box** (mcp.path2ai.tech).
+>
+> A single behaviour change usually touches **both** (the rule says *what*, the MCP example gives the *code*) — tune one without the other and they drift. Then **update the Terminal Bible** (§12 Distribution & releases) so the docs stay current. Distribution/versioning specifics per platform live in the SDK repos.
+
+## Layout
+
+```
+src/cli.ts                                   the bootstrap program
+rules/
+  ios/path-integration.mdc                   iOS (Swift / SPM)
+  android/path-integration-android.mdc       Android (Kotlin / Gradle)
+  windows-11/path-integration-windows11.mdc  Windows 11 (WinUI 3 / .NET 10)
+  windows-10/path-integration-windows10.mdc  Windows 10 (WPF / .NET Framework 4.8)
+build.mjs                                    builds dist/cli.js + dist/init.js
+```
+
+## How a customer runs it
+
+**Every platform (published to npm) — run from the project root:**
+```bash
+npx path-terminal-init
+```
+Works on macOS, Linux and Windows (PowerShell or CMD). Needs Node installed. It
+auto-detects iOS / Android / Windows 11 (WinUI 3) / Windows 10 (WPF). Add `--agent cursor`
+for Cursor (default is Claude Code).
+
+> **Windows PowerShell:** on a fresh box plain `npx` fails with *"npx.ps1 cannot be loaded
+> because running scripts is disabled on this system"* — that's PowerShell's default
+> execution policy blocking Node's `.ps1` shim, not an install problem. Run the `.cmd`
+> shim instead (works under any policy, no admin, no config change):
+>
+> ```powershell
+> npx.cmd path-terminal-init
+> ```
+>
+> Or fix it once with `Set-ExecutionPolicy -Scope CurrentUser RemoteSigned`, after which
+> plain `npx` works. CMD is unaffected, and the no-npm alternative below runs `node.exe`
+> directly so it never hits the policy at all.
+
+**Alternative — fetch from the help server (no npm):**
+```bash
+# macOS / Linux:
+node <(curl -s https://mcp.path2ai.tech/init.js) --agent claude
+# Windows PowerShell:
+curl.exe -s https://mcp.path2ai.tech/init.js -o "$env:TEMP\path-init.js"; node "$env:TEMP\path-init.js" --agent claude
+```
+
+The CLI writes a `.mcp.json` (connecting the agent to `https://mcp.path2ai.tech`), adds the
+SDK dependency, and drops the matching recipe into `.cursor/rules/` and/or `CLAUDE.md`.
+
+## Develop locally
+
+```bash
+npm install
+npm run build      # → dist/cli.js (installable) + dist/init.js (standalone bundle)
+npm run typecheck
+node dist/cli.js --help
+```
+
+## Two artifacts, one source
+
+- `dist/cli.js` — the installable CLI. Reads recipes from the local `rules/<os>/` folder.
+- `dist/init.js` — a self-contained bundle for the `curl … | node` one-liner. It runs with
+  no local `rules/` folder, so it fetches the recipe from the server's `/rules` endpoint.
+
+`Path-mcp-server` serves `dist/init.js` at `/init.js` and the `rules/` files at `/rules*`.
+Its deploy copies them from this repo, so the server is never a stale duplicate.
+
+## Publishing updates to npm
+
+Published as **[`path-terminal-init`](https://www.npmjs.com/package/path-terminal-init)** (public).
+To ship a new version: bump `version` in `package.json`, then:
+
+```bash
+npm login                       # if not already logged in
+npm publish --access public     # prepublishOnly rebuilds dist/ first
+npm view path-terminal-init version
+```
+
+`npx path-terminal-init` always fetches the latest published version.