@khanglvm/relay 0.8.1 → 0.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -28
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -25,8 +25,9 @@ npm i -g @khanglvm/relay
|
|
|
25
25
|
# the agent skill → every detected agent (Claude Code, Codex, Cursor, …)
|
|
26
26
|
npx skills add khanglvm/relay --skill relay --all
|
|
27
27
|
|
|
28
|
-
# enforce it (recommended) — a skill alone is an ignorable hint
|
|
29
|
-
# writes relay's
|
|
28
|
+
# enforce it (recommended) — a skill alone is an ignorable hint; `rly install`
|
|
29
|
+
# writes relay's usage rules into the file each agent reads (run `rly install`
|
|
30
|
+
# with no args to see every supported target and where it lands):
|
|
30
31
|
rly install --all # every agent detected on this machine
|
|
31
32
|
```
|
|
32
33
|
|
|
@@ -36,32 +37,6 @@ it opens a board like the ones above and waits for your Submit.
|
|
|
36
37
|
Keep relay current with **`rly upgrade`** — it installs the latest CLI and
|
|
37
38
|
refreshes the skill in one step, leaving any boards you have open untouched.
|
|
38
39
|
|
|
39
|
-
### Tell your agent to actually use it
|
|
40
|
-
|
|
41
|
-
A skill is just an ignorable hint — relay's short usage rules in the file your
|
|
42
|
-
agent *always* reads are what make it reach for relay. **`rly install` writes
|
|
43
|
-
those rules into the right file for each agent**, cross-platform (macOS / Linux /
|
|
44
|
-
Windows):
|
|
45
|
-
|
|
46
|
-
```sh
|
|
47
|
-
rly install --all # every agent detected on this machine
|
|
48
|
-
rly install --target claude # → ~/.claude/CLAUDE.md
|
|
49
|
-
rly install --target cursor # → .cursor/rules/relay.mdc (with frontmatter)
|
|
50
|
-
rly install --target copilot # → .github/copilot-instructions.md (+ JetBrains global)
|
|
51
|
-
rly install # no target: print the agent → file map for your OS
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
Supported targets: `claude`, `codex`, `cursor`, `copilot` (VS Code / Visual Studio /
|
|
55
|
-
JetBrains), `kiro`, `windsurf`, `cline`, `gemini`, `opencode`, `droid` (Factory), and
|
|
56
|
-
the generic `agents` (`AGENTS.md`). Flags: `--scope global|project` (where the rules
|
|
57
|
-
land), `--print` (emit the text + resolved path for manual copy/paste), `--list`.
|
|
58
|
-
relay's block is marker-delimited and idempotent — re-running updates only that block
|
|
59
|
-
and leaves the rest of your file alone.
|
|
60
|
-
|
|
61
|
-
Using an agent that isn't listed? `rly skill rules` prints the block to paste into
|
|
62
|
-
whatever file or settings panel it reads — e.g. Cursor's *Settings → Rules → User
|
|
63
|
-
Rules* or Copilot's custom instructions (their *user-level* rules aren't file-based).
|
|
64
|
-
|
|
65
40
|
## What it improves
|
|
66
41
|
|
|
67
42
|
| Without relay | With relay |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@khanglvm/relay",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.2",
|
|
4
4
|
"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.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai-agents",
|