@uge/payo 2.3.3 → 2.4.1

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.
Files changed (3) hide show
  1. package/README.md +23 -13
  2. package/dist/index.js +163 -162
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -48,7 +48,8 @@ interactive CLI that **interviews you about your project** — language, framewo
48
48
  database, auth, testing, conventions — and then **generates the guidance files
49
49
  your assistant actually reads.**
50
50
 
51
- It supports **Claude, Cursor, GitHub Copilot, Codex, Windsurf, and Antigravity**.
51
+ It supports **Claude, Cursor, GitHub Copilot, Codex, Windsurf, Zed, and
52
+ Antigravity**.
52
53
  Where the assistant ships a headless CLI, Payo drives that tool's own AI to
53
54
  write rich, project-specific docs; where it doesn't, Payo falls back to solid
54
55
  templates — so you always end up with usable output.
@@ -67,7 +68,7 @@ and let it rot.
67
68
 
68
69
  Payo writes them for you in minutes — tailored to your actual stack, in one
69
70
  universal layout that **every skills-compatible tool reads** (Claude Code, Codex,
70
- Cursor, Copilot, Gemini, Antigravity, Windsurf, …) — so your assistant follows
71
+ Cursor, Copilot, Gemini, Antigravity, Windsurf, Zed, …) — so your assistant follows
71
72
  _your_ conventions from the first prompt instead of guessing.
72
73
 
73
74
  ### Vibe coding, without the mess
@@ -127,7 +128,7 @@ setup, or a folder layout your project never adopted.
127
128
  an agent can skip prose. When you enable a guardrail, Payo also writes the
128
129
  mechanism that makes it fire: a git hook — in the runner you pick — that
129
130
  hard-blocks the commit or push, and a native pre-tool gate for Claude, Cursor,
130
- and Copilot. It plans both
131
+ Copilot, Codex, and Antigravity. It plans both
131
132
  layers together, so each check runs in exactly one place — the agent is told not
132
133
  to re-run what a hook already runs.
133
134
 
@@ -297,12 +298,18 @@ One universal layout, whichever agent CLI you pick — no per-tool formats:
297
298
 
298
299
  Who reads what, with no extra work:
299
300
 
300
- - **Codex, Cursor, Copilot, Gemini CLI, Antigravity, Devin** → `.agents/skills/` and
301
- `AGENTS.md` natively.
301
+ - **Codex, Cursor, Copilot, Gemini CLI, Antigravity, Zed, Devin** → `.agents/skills/`
302
+ and `AGENTS.md` natively.
302
303
  - **Claude Code** → the `CLAUDE.md` shim plus the `.claude/skills/` symlinks
303
304
  (officially supported; it dedupes if it also reads the target directly).
304
305
  - **Windsurf** → `AGENTS.md` plus the `.windsurf/skills/` shim.
305
306
 
307
+ > **Zed users:** Zed reads only the **first** instruction file it finds, in the order
308
+ > `.rules`, `.cursorrules`, `.windsurfrules`, `.clinerules`,
309
+ > `.github/copilot-instructions.md`, `AGENT.md`, `AGENTS.md`. If your repo holds any
310
+ > of the files above `AGENTS.md`, Zed ignores everything Payo generated — so Payo
311
+ > warns you at the end of a run and leaves the file for you to remove or merge.
312
+
306
313
  `AGENTS.md` opens its skills index with a directive telling the agent to consult and
307
314
  follow the applicable skills before writing code — so the guidance is used, not just
308
315
  present.
@@ -334,14 +341,17 @@ when you enable a guardrail, Payo also writes the hook that makes it fire regard
334
341
  runs and, by default, **leaves your setup completely untouched**. Anything it
335
342
  already covers is simply never added; for anything missing, Payo asks whether to
336
343
  append it or leave the file alone, and leaving it alone is the recommended answer.
337
- - **A native tool hook.** For **Claude, Cursor, and Copilot**, Payo writes a
338
- `PreToolUse` hook that fires when the agent runs `git commit` / `git push` or a
339
- destructive query. Confirm-push and DB-safety raise a **confirm prompt for you**.
340
- Change-audit instead **denies the command once** with an instruction back to the
341
- agent — a confirm prompt would just be approved and the audit skipped — and the
342
- retry for that same change goes through. It stores nothing outside `.git/` and runs
343
- no model. Tools without a pre-tool hook (Codex, Antigravity, Windsurf) are covered
344
- by the git hook above.
344
+ - **A native tool hook.** For **Claude, Cursor, Copilot, Codex, and Antigravity**,
345
+ Payo writes a pre-tool hook that fires when the agent runs `git commit` /
346
+ `git push` or a destructive query. Confirm-push and DB-safety raise a **confirm
347
+ prompt for you**. Change-audit instead **denies the command** with an instruction
348
+ back to the agent — a confirm prompt would just be approved and the audit skipped
349
+ — and the gate stays shut until the change-audit skill records a pass for *that
350
+ exact change*. The receipt it writes lives inside `.git/`, so it is never
351
+ committed, and a later commit moves the key it is stamped with, re-closing the
352
+ gate. It stores nothing outside `.git/` and runs no model. Codex needs one
353
+ one-time `/hooks` trust step, which Payo prints. Tools with no usable pre-tool
354
+ gate (Windsurf, Zed) are covered by the git hook above.
345
355
 
346
356
  Both are **idempotent** — re-running Payo never duplicates a hook — and are written
347
357
  only for the guardrails you actually enabled. Whatever a hook runs, the generated