From b07271e0b638492a9ab4069f1d5626e7b5328781 Mon Sep 17 00:00:00 2001 From: Naor Sabag <32329815+naorsabag@users.noreply.github.com> Date: Mon, 4 May 2026 17:28:18 +0000 Subject: [PATCH 1/5] =?UTF-8?q?docs(readme):=20layer=20in=20spec-03=20beat?= =?UTF-8?q?s=20=E2=80=94=20npm=20badge,=20Tier-1/Tier-2=20split,=20hyperli?= =?UTF-8?q?nked=20clients=20(closes=20W4)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit W4 from READINESS-AUDIT.md called for the launch-doc-spec-03 README beats. This adds the load-bearing pieces without depending on services we haven't stood up yet: - npm version badge wired to the (eventual) https://www.npmjs.com/package/openhop — shields.io renders "no published" until B4 publishes openhop@0.1.0. - "Works with" badge row split into two: * Tier-1 (one-step): Claude Code / Cursor / Windsurf / Cline / Continue.dev — each badge is a hyperlink to the client's official skills/rules docs URL (cited in packages/cli/src/init.ts:70-84). Continue.dev keeps its "advisory" mark per init.ts. * Tier-2 (via OpenSkills): Codex CLI, Gemini CLI, JetBrains Junie, GitHub Copilot, OpenCode, Goose, Antigravity — each linked to the client homepage. Aider sits next to them with a "CLI only*" footnote since it has no skill surface. - Install table grows a "Tier 1" / "everything else" row pair mirroring the badge split. The Tier-2 row is the universal-install line per 17:534 (`npx openskills install naorsabag/openhop`). Deferred until services exist (called out separately in the audit): - Discord link/CTA (no Discord registered yet) - npm version badge will only render usefully once B4 (npm publish) lands Verified: prettier --check clean. All hyperlink targets return 200 (including shields.io badge generators for the new "via OpenSkills" and "CLI only*" badges). Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 40 ++++++++++++++++++++++++++++------------ 1 file changed, 28 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f635673..60d4cd4 100644 --- a/README.md +++ b/README.md @@ -18,19 +18,34 @@

CI + npm version MIT License GitHub stars

- Works with
- Claude Code - Cursor - Windsurf - Cline - Continue.dev (advisory) + One-step install (npx openhop init):
+ Claude Code + Cursor + Windsurf + Cline + Continue.dev (advisory)

+

+ Via OpenSkills (npx openskills install naorsabag/openhop):
+ OpenAI Codex CLI + Gemini CLI + JetBrains Junie + GitHub Copilot + OpenCode + Goose + Antigravity + Aider (CLI only) +

+ +

* Aider has no skill surface — install the openhop CLI globally and invoke commands via Aider's shell access.

+ --- ## Why @@ -60,12 +75,13 @@ That's it. The CLI starts the API + web UI on `localhost:8787` / `:8788`, posts ## Install -| Scenario | Command | -| ---------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | -| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | -| **Install the agent skill** | `npx openhop init` — copies `SKILL.md` into every detected AI client | -| **Run from source (contributors)** | `git clone … && npm install && npm run dev` — see [Contributing](#contributing) | +| Scenario | Command | +| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | +| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | +| **Install the skill — Tier 1** | `npx openhop init` — auto-detects Claude Code, Cursor, Windsurf, Cline, Continue.dev and drops `SKILL.md` in place | +| **Install the skill — everything else** | `npx openskills install naorsabag/openhop` — covers Codex CLI, Gemini CLI, Junie, Copilot, OpenCode, Goose, Antigravity, … | +| **Run from source (contributors)** | `git clone … && npm install && npm run dev` — see [Contributing](#contributing) | ## Give your agent the skill From b7efb08fd6def11e01ecda24c61db9e99cd43b84 Mon Sep 17 00:00:00 2001 From: Naor Sabag <32329815+naorsabag@users.noreply.github.com> Date: Tue, 5 May 2026 07:40:23 +0000 Subject: [PATCH 2/5] docs(readme): address #72 review nits MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Tier-1 install row: call out that Continue.dev support is advisory. The badge row already marks it that way; the install row was implying full auto-detect parity. Fixes that mismatch (CodeRabbit @ README:82). - Contributor row: replace `git clone …` placeholder with a real, copy-pasteable command including the repo URL and `cd OpenHop` (CodeRabbit @ README:84). Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 60d4cd4..4eca949 100644 --- a/README.md +++ b/README.md @@ -79,9 +79,9 @@ That's it. The CLI starts the API + web UI on `localhost:8787` / `:8788`, posts | --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | | **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | -| **Install the skill — Tier 1** | `npx openhop init` — auto-detects Claude Code, Cursor, Windsurf, Cline, Continue.dev and drops `SKILL.md` in place | +| **Install the skill — Tier 1** | `npx openhop init` — auto-detects Claude Code, Cursor, Windsurf, Cline (Continue.dev support is advisory) and drops `SKILL.md` in place | | **Install the skill — everything else** | `npx openskills install naorsabag/openhop` — covers Codex CLI, Gemini CLI, Junie, Copilot, OpenCode, Goose, Antigravity, … | -| **Run from source (contributors)** | `git clone … && npm install && npm run dev` — see [Contributing](#contributing) | +| **Run from source (contributors)** | `git clone https://github.com/naorsabag/OpenHop.git && cd OpenHop && npm install && npm run dev` — see [Contributing](#contributing) | ## Give your agent the skill From f9aa3fd331b95c0d86174d6894b472e64a0b6193 Mon Sep 17 00:00:00 2001 From: Naor Sabag <32329815+naorsabag@users.noreply.github.com> Date: Tue, 5 May 2026 08:00:42 +0000 Subject: [PATCH 3/5] docs(readme): collapse badges to one row of three (Claude Code, Cursor, Codex) Drops the Tier-1/Tier-2 framing entirely. The badge bar now shows the three flagship clients in a single line; the longer list of supported clients (Windsurf, Cline, Codex, Gemini, Junie, Copilot, OpenCode, Goose, Antigravity, Aider) lives only in the install table. Install-table rows still distinguish the two install paths (`openhop init` vs `openskills install`), but the column labels lose the "Tier 1" language and just enumerate the clients in parentheses. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 34 +++++++++------------------------- 1 file changed, 9 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 4eca949..dfb917b 100644 --- a/README.md +++ b/README.md @@ -24,28 +24,12 @@

- One-step install (npx openhop init):
+ Works with
Claude Code Cursor - Windsurf - Cline - Continue.dev (advisory) + OpenAI Codex

-

- Via OpenSkills (npx openskills install naorsabag/openhop):
- OpenAI Codex CLI - Gemini CLI - JetBrains Junie - GitHub Copilot - OpenCode - Goose - Antigravity - Aider (CLI only) -

- -

* Aider has no skill surface — install the openhop CLI globally and invoke commands via Aider's shell access.

- --- ## Why @@ -75,13 +59,13 @@ That's it. The CLI starts the API + web UI on `localhost:8787` / `:8788`, posts ## Install -| Scenario | Command | -| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | -| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | -| **Install the skill — Tier 1** | `npx openhop init` — auto-detects Claude Code, Cursor, Windsurf, Cline (Continue.dev support is advisory) and drops `SKILL.md` in place | -| **Install the skill — everything else** | `npx openskills install naorsabag/openhop` — covers Codex CLI, Gemini CLI, Junie, Copilot, OpenCode, Goose, Antigravity, … | -| **Run from source (contributors)** | `git clone https://github.com/naorsabag/OpenHop.git && cd OpenHop && npm install && npm run dev` — see [Contributing](#contributing) | +| Scenario | Command | +| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | +| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | +| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | +| **Install the skill** (Claude Code, Cursor, Windsurf, Cline) | `npx openhop init` — auto-detects your AI client and drops `SKILL.md` in place | +| **Install the skill** (Codex, Gemini, Junie, Copilot, …) | `npx openskills install naorsabag/openhop` — universal install via OpenSkills | +| **Run from source (contributors)** | `git clone https://github.com/naorsabag/OpenHop.git && cd OpenHop && npm install && npm run dev` — see [Contributing](#contributing) | ## Give your agent the skill From c436bd7272067bf150341d131f36498d3fe9ee46 Mon Sep 17 00:00:00 2001 From: Naor Sabag <32329815+naorsabag@users.noreply.github.com> Date: Tue, 5 May 2026 14:26:20 +0000 Subject: [PATCH 4/5] docs(readme): restore Continue.dev advisory note in init row MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The tier-collapse in f9aa3fd dropped Continue.dev from the install table's parenthesized client list. init.ts still detects Continue.dev (advisory), so the row should mention it for honesty. Addresses the second of two CodeRabbit nits on f9aa3fd. The first nit (badge selection should mirror the install-table tier structure) is intentionally not actioned — the user's request was to highlight three flagship clients (Claude Code, Cursor, Codex) regardless of install mechanism. Replied on the PR thread. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index dfb917b..ecd8c96 100644 --- a/README.md +++ b/README.md @@ -59,13 +59,13 @@ That's it. The CLI starts the API + web UI on `localhost:8787` / `:8788`, posts ## Install -| Scenario | Command | -| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | -| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | -| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | -| **Install the skill** (Claude Code, Cursor, Windsurf, Cline) | `npx openhop init` — auto-detects your AI client and drops `SKILL.md` in place | -| **Install the skill** (Codex, Gemini, Junie, Copilot, …) | `npx openskills install naorsabag/openhop` — universal install via OpenSkills | -| **Run from source (contributors)** | `git clone https://github.com/naorsabag/OpenHop.git && cd OpenHop && npm install && npm run dev` — see [Contributing](#contributing) | +| Scenario | Command | +| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | +| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | +| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | +| **Install the skill** (Claude Code, Cursor, Windsurf, Cline; Continue.dev advisory) | `npx openhop init` — auto-detects your AI client and drops `SKILL.md` in place | +| **Install the skill** (Codex, Gemini, Junie, Copilot, …) | `npx openskills install naorsabag/openhop` — universal install via OpenSkills | +| **Run from source (contributors)** | `git clone https://github.com/naorsabag/OpenHop.git && cd OpenHop && npm install && npm run dev` — see [Contributing](#contributing) | ## Give your agent the skill From 645f3e4f5002eb56ed74d0332e84cb1951c9a581 Mon Sep 17 00:00:00 2001 From: Naor Sabag <32329815+naorsabag@users.noreply.github.com> Date: Tue, 5 May 2026 14:31:40 +0000 Subject: [PATCH 5/5] docs(readme): drop Continue.dev advisory note from install row MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Per follow-up, take Continue.dev out of the Tier-1 install row's parenthesized client list. Reverts c436bd7. The Features bullet at line 44 still mentions Continue as part of the supported-client prose list — that's flavor copy, not a tag. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ecd8c96..dfb917b 100644 --- a/README.md +++ b/README.md @@ -59,13 +59,13 @@ That's it. The CLI starts the API + web UI on `localhost:8787` / `:8788`, posts ## Install -| Scenario | Command | -| ----------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | -| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | -| **Install the skill** (Claude Code, Cursor, Windsurf, Cline; Continue.dev advisory) | `npx openhop init` — auto-detects your AI client and drops `SKILL.md` in place | -| **Install the skill** (Codex, Gemini, Junie, Copilot, …) | `npx openskills install naorsabag/openhop` — universal install via OpenSkills | -| **Run from source (contributors)** | `git clone https://github.com/naorsabag/OpenHop.git && cd OpenHop && npm install && npm run dev` — see [Contributing](#contributing) | +| Scenario | Command | +| ------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- | +| **One-shot demo** | `npx openhop demo` — boots everything and opens the browser | +| **Long-lived local server** | `npx openhop serve` — API + web UI, no starter flow (or `npm install -g openhop` first if you'd rather have the global `openhop` binary) | +| **Install the skill** (Claude Code, Cursor, Windsurf, Cline) | `npx openhop init` — auto-detects your AI client and drops `SKILL.md` in place | +| **Install the skill** (Codex, Gemini, Junie, Copilot, …) | `npx openskills install naorsabag/openhop` — universal install via OpenSkills | +| **Run from source (contributors)** | `git clone https://github.com/naorsabag/OpenHop.git && cd OpenHop && npm install && npm run dev` — see [Contributing](#contributing) | ## Give your agent the skill