@khanglvm/relay 0.8.0 → 0.8.1

package/README.md

@@ -25,42 +25,42 @@ npm i -g @khanglvm/relay
 # the agent skill → every detected agent (Claude Code, Codex, Cursor, …)
 npx skills add khanglvm/relay --skill relay --all
 
-# enforce it (recommended) — a skill alone is an ignorable hint; append relay's
-# short usage rules to your agent's global instructions (per-agent commands below)
-rly skill rules
+# enforce it (recommended) — a skill alone is an ignorable hint. `rly install`
+# writes relay's short usage rules into the right file for each agent (details below):
+rly install --all          # every agent detected on this machine
 ```
 
 That's it. Next time your agent needs a decision or wants to show you a plan,
 it opens a board like the ones above and waits for your Submit.
 
+Keep relay current with **`rly upgrade`** — it installs the latest CLI and
+refreshes the skill in one step, leaving any boards you have open untouched.
+
 ### Tell your agent to actually use it
 
-`rly skill rules` prints relay's short usage rules. A skill is just an ignorable
-hint — these rules in the file your agent *always* reads are what make it reach for
-relay. Append them to your agent's **global** instructions:
+A skill is just an ignorable hint — relay's short usage rules in the file your
+agent *always* reads are what make it reach for relay. **`rly install` writes
+those rules into the right file for each agent**, cross-platform (macOS / Linux /
+Windows):
 
 ```sh
-rly skill rules >> ~/.claude/CLAUDE.md          # Claude Code
-rly skill rules >> ~/.codex/AGENTS.md           # Codex
-rly skill rules >> ~/.gemini/GEMINI.md          # Gemini CLI
-rly skill rules >> ~/.config/opencode/AGENTS.md # OpenCode
+rly install --all                # every agent detected on this machine
+rly install --target claude      # → ~/.claude/CLAUDE.md
+rly install --target cursor      # → .cursor/rules/relay.mdc (with frontmatter)
+rly install --target copilot     # → .github/copilot-instructions.md (+ JetBrains global)
+rly install                      # no target: print the agent → file map for your OS
 ```
 
-Cursor and GitHub Copilot keep global rules in a settings panel, not a file — run
-`rly skill rules` and paste the output into Cursor's *Settings → Rules → User Rules*
-or Copilot's custom-instructions.
-
-<details>
-<summary>More agents</summary>
-
-```sh
-rly skill rules >> ~/.codeium/windsurf/memories/global_rules.md # Windsurf
-rly skill rules >> ~/.factory/AGENTS.md                         # Droid (Factory)
-```
+Supported targets: `claude`, `codex`, `cursor`, `copilot` (VS Code / Visual Studio /
+JetBrains), `kiro`, `windsurf`, `cline`, `gemini`, `opencode`, `droid` (Factory), and
+the generic `agents` (`AGENTS.md`). Flags: `--scope global|project` (where the rules
+land), `--print` (emit the text + resolved path for manual copy/paste), `--list`.
+relay's block is marker-delimited and idempotent — re-running updates only that block
+and leaves the rest of your file alone.
 
-Any other agent: run `rly skill rules` and paste the block into whatever file or
-settings panel it reads as global instructions.
-</details>
+Using an agent that isn't listed? `rly skill rules` prints the block to paste into
+whatever file or settings panel it reads — e.g. Cursor's *Settings → Rules → User
+Rules* or Copilot's custom instructions (their *user-level* rules aren't file-based).
 
 ## What it improves
 
@@ -82,6 +82,8 @@ Node ≥ 18; Chart.js / Mermaid / Graphviz are vendored and lazy-loaded offline.
 | | |
 |---|---|
 | `rly help` | every command at a glance |
+| `rly install --target <agent>` | write relay's rules into an agent's instruction file — `claude` `codex` `cursor` `copilot` `kiro` `windsurf` `cline` `gemini` `opencode` `droid` `agents`; `--all`, `--scope`, `--print`, `--list` |
+| `rly upgrade` | update the CLI **and** refresh the skill in one step (safe around open boards; `--dry-run`, `--cli-only`, `--skill-only`) |
 | `rly agent` | the full agent guide — spec format, all block types, annotations, patterns ([docs/AGENT.md](docs/AGENT.md)) |
 | `rly schema` | board spec JSON Schema |
 | [skills/relay/SKILL.md](skills/relay/SKILL.md) | the bundled skill |
@@ -94,6 +96,28 @@ npm test     # zero-dep smoke tests (spawns real servers, fake-submits)
 
 ## Changelog
 
+### 0.8.1
+- `rly install` adds **OpenCode** (`~/.config/opencode/AGENTS.md`) and **Droid /
+  Factory** (`~/.factory/AGENTS.md`) targets.
+- README documents `rly install` and `rly upgrade`.
+
+### 0.8.0 — install into any agent
+- **`rly install --target <agent>`** writes relay's usage rules into the right
+  file for Claude Code, Codex, Cursor, GitHub Copilot (VS Code / Visual Studio /
+  JetBrains), Kiro, Windsurf, Cline, Gemini, or the generic `AGENTS.md` —
+  cross-platform (macOS / Linux / Windows), idempotent, with `--all`, `--scope`,
+  and `--print`.
+- Fixed `rly skill install` crashing when the target skill dir was a symlink.
+
+### 0.7.0 — sturdier boards, self-update
+- **Markdown blocks render GFM tables**; element comments moved to an
+  Outline-style right sidebar with inline highlights on commented text.
+- **Seamless timeouts** — a detached board that runs past its deadline keeps
+  serving so you can still submit (it lands as `submitted`); the page shows a
+  calm note instead of disconnecting.
+- **`rly upgrade`** — install the latest CLI and refresh the skill in one step.
+- Per-question notes are multi-line textboxes.
+
 ### 0.6.0 — comment on anything
 - **Comment on any part of a custom-HTML mockup.** Hover any element — a heading,
   a button, a card, the price — and a pin appears to leave an inline note. No

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khanglvm/relay",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Browser-based question boards with rich blocks (markdown, charts, mermaid, tables, code, sandboxed HTML) and element-level annotations for AI coding agents (Claude Code, Codex, …): ask users structured questions, present interactive visuals, collect inline comments, wait for submit, read answers as JSON.",
   "keywords": [
     "ai-agents",

package/src/cli.js

@@ -821,7 +821,7 @@ function platformDirs({ platform, home, env }) {
   const jetbrainsCopilot = platform === 'win32'
     ? path.join(localApp, 'github-copilot', 'intellij')
     : path.join(xdg, 'github-copilot', 'intellij');
-  return { jetbrainsCopilot, documents: path.join(home, 'Documents') };
+  return { xdg, jetbrainsCopilot, documents: path.join(home, 'Documents') };
 }
 
 // The relay instruction registry. Each agent declares how to install relay's
@@ -877,6 +877,14 @@ export function agentRegistry({ platform = process.platform, home = os.homedir()
       detect: j(home, '.gemini'),
       global: { file: j(home, '.gemini', 'GEMINI.md'), style: 'shared' },
       project: { file: j(cwd, 'GEMINI.md'), style: 'shared' } },
+    { id: 'opencode', label: 'OpenCode',
+      detect: j(d.xdg, 'opencode'),
+      global: { file: j(d.xdg, 'opencode', 'AGENTS.md'), style: 'shared' },
+      project: { file: j(cwd, 'AGENTS.md'), style: 'shared' } },
+    { id: 'droid', label: 'Droid (Factory)',
+      detect: j(home, '.factory'),
+      global: { file: j(home, '.factory', 'AGENTS.md'), style: 'shared' },
+      project: { file: j(cwd, 'AGENTS.md'), style: 'shared' } },
   ];
 }
 
@@ -1144,7 +1152,7 @@ USAGE
   rly skill [install|rules|path]      bundled universal agent skill (Claude Code, Codex, …)
                                       \`rly skill rules >> CLAUDE.md\` adds always-read usage rules
   rly install --target <agent>        inject relay's rules into an agent's instruction file
-                                      agents: claude codex cursor copilot kiro windsurf cline gemini agents
+                                      claude codex cursor copilot kiro windsurf cline gemini opencode droid agents
                                       --scope global|project · --print (copy/paste) · --all · --list (no flags)
   rly upgrade                         install the latest CLI globally + refresh the skill in one step
                                       --stop/--force handle running boards · --dry-run · --cli-only/--skill-only