diff --git a/README.md b/README.md index 9ffd8c9..a457c5e 100644 --- a/README.md +++ b/README.md @@ -140,7 +140,7 @@ That's it. Install and update via `@imdeadpool/guardex`. Setup installs the mini > [!NOTE] -> In this repo, `CLAUDE.md` is a symlink to `AGENTS.md`, so Claude reads the same contract. Optional Codex/Claude companion files still install at the user level with `gx install-agent-skills`, while the generic repo skill catalog is available through `npx skills add recodeee/gitguardex`. +> In this repo, `CLAUDE.md` is a symlink to `AGENTS.md`, so Claude reads the same contract. Optional Codex/Claude companion files still install at the user level with `gx install-agent-skills`, while the generic repo skill catalog is available through `npx skills add recodeee/` or directly via `npx skills add recodeee/gitguardex`. ### Decision flow @@ -461,13 +461,17 @@ Repo: ### GitGuardex skills - install the repo skill catalog through `npx skills` -For agents that already support the generic `skills` installer flow, GitGuardex now exposes its repo skill catalog directly. That lets the installer show the available Guardex skills first, then install only the one you want. +For agents that already support the generic `skills` installer flow, GitGuardex now exposes its repo skill catalog directly. You can start from the broader `recodeee` source or jump straight into this repo's catalog. + +```sh +npx skills add recodeee/ +``` ```sh npx skills add recodeee/gitguardex ``` -This repo currently exposes `gitguardex` and `guardex-merge-skills-to-dev` through that flow. Use `gx install-agent-skills` when you want the Codex/Claude user-home startup files instead of the generic `skills` catalog. +This repo currently exposes `gitguardex` and `guardex-merge-skills-to-dev` through that flow. If the picker does not show a separate `guardex` skill, that is expected: `guardex` remains the legacy CLI alias, while the repo skill itself is named `gitguardex`. Use `gx install-agent-skills` when you want the Codex/Claude user-home startup files instead of the generic `skills` catalog. Repo: [![GitHub stars](https://img.shields.io/github/stars/recodeee/gitguardex?style=social)](https://github.com/recodeee/gitguardex) @@ -622,7 +626,7 @@ vscode/guardex-active-agents/README.md Legacy compatibility note: older repos may still contain repo-local workflow scripts under `scripts/`. Direct `gx branch ...`, `gx locks ...`, `gx finish`, `gx cleanup`, `gx merge`, and `gx migrate` do not require them. `gx migrate` removes those leftover workflow shims by default. The CLI still honors repo-local `scripts/review-bot-watch.sh` and `scripts/codex-agent.sh` when they are already present so older repos can keep working during migration. -Optional Codex/Claude user-level companions still install with `gx install-agent-skills`; the generic repo skill catalog is available with `npx skills add recodeee/gitguardex`. Neither path copies those user-home files into each repo. +Optional Codex/Claude user-level companions still install with `gx install-agent-skills`; the generic repo skill catalog is available with `npx skills add recodeee/` or directly via `npx skills add recodeee/gitguardex`. Neither path copies those user-home files into each repo. --- diff --git a/openspec/changes/agent-codex-add-npx-skills-install-surface-2026-04-23-17-47/notes.md b/openspec/changes/agent-codex-add-npx-skills-install-surface-2026-04-23-17-47/notes.md index ccbee65..97b498d 100644 --- a/openspec/changes/agent-codex-add-npx-skills-install-surface-2026-04-23-17-47/notes.md +++ b/openspec/changes/agent-codex-add-npx-skills-install-surface-2026-04-23-17-47/notes.md @@ -1,5 +1,6 @@ # T1 Notes -- Add a repo-root `skills/` catalog so `npx skills add recodeee/gitguardex` shows the Guardex skills the same way Caveman does. +- Add a repo-root `skills/` catalog so `npx skills add recodeee/` and `npx skills add recodeee/gitguardex` both have a documented path into the Guardex skills picker. - Keep the existing `gx install-agent-skills` path for Codex/Claude user-home startup files; this change adds a generic skills-installer path, not a replacement. - Keep the merge-helper runbook and README aligned with the new root skill paths so future skill-only lanes do not miss them. +- Clarify in README that the picker shows `gitguardex`, not a separate `guardex` skill, because `guardex` is a legacy CLI alias rather than a second repo skill entry. diff --git a/test/metadata.test.js b/test/metadata.test.js index 46adae4..8b011cb 100644 --- a/test/metadata.test.js +++ b/test/metadata.test.js @@ -73,7 +73,9 @@ test('README documents gx release as README-driven GitHub release writer', () => test('README advertises the repo skills installer path and root skills stay in sync with shipped templates', () => { const readme = fs.readFileSync(readmePath, 'utf8'); + assert.match(readme, /npx skills add recodeee\//); assert.match(readme, /npx skills add recodeee\/gitguardex/); + assert.match(readme, /picker does not show a separate `guardex` skill, that is expected/); const pairs = [ ['templates/codex/skills/gitguardex/SKILL.md', 'skills/gitguardex/SKILL.md'],