From b36220b33a14d27d2595b4592f507e1e33678406 Mon Sep 17 00:00:00 2001 From: zfc Date: Wed, 11 Mar 2026 16:17:54 +0800 Subject: [PATCH] Prefer slash commands for Codex skills --- .codex/skills/AGENTS.md.template | 5 ++- .codex/skills/doc/SKILL.md | 6 +-- AGENTS.md | 2 +- AGENTS.md.template | 2 +- README.md | 70 ++++++++++++++++---------------- 5 files changed, 42 insertions(+), 43 deletions(-) diff --git a/.codex/skills/AGENTS.md.template b/.codex/skills/AGENTS.md.template index 3e419ed..512dc98 100644 --- a/.codex/skills/AGENTS.md.template +++ b/.codex/skills/AGENTS.md.template @@ -28,13 +28,14 @@ - `doc`: 渐进式文档生成器。首次只写精炼梗概（≤300字），后续通过迭代不断完善。 (file: `./.codex/skills/doc/SKILL.md`) - `update`: 收集用户反馈并更新最近使用的 skill。别名：`up`。 (file: `./.codex/skills/up/SKILL.md`) - `deploy`: Drone CI + 服务器 CD 全流程引导：从基础设施检查到生成配置文件到验证部署，交互式完成。 (file: `./.codex/skills/deploy/SKILL.md`) +- `issue`: 获取任意 Gitea 仓库的 issue 列表和单条详情，支持状态筛选、完整仓库 URL 输入和格式化输出。 (file: `./.codex/skills/issue/SKILL.md`) - `changelog`: 一键发版：生成更新日志 → commit → 打 tag，全流程自动化。 (file: `./.codex/skills/changelog/SKILL.md`) ### How to use skills - Discovery: 以上列表就是当前项目注册给 Codex 的 skills。 -- Trigger rules: 如果用户显式提到 skill 名称（例如 `$rr`、`rr skill`、`用 rr 评审`），或任务明显匹配 skill 描述，优先使用对应 skill。 -- Codex usage: 在 Codex 中优先使用 `$skill-name` 或自然语言；skill 文档里出现的 `/rr`、`/go` 等 slash command 只是 Claude Code 的兼容写法。 +- Trigger rules: 如果用户显式提到 skill 名称（例如 `/rr`、`$rr`、`rr skill`、`用 rr 评审`），或任务明显匹配 skill 描述，优先使用对应 skill。 +- Codex usage: 在 Codex 中优先使用 `/skill-name`；兼容历史 `$skill-name` 写法，也支持自然语言触发。 - Missing/blocked: 如果某个 skill 文件不存在或无法读取，简短说明并回退到普通实现方式。 - Context hygiene: 只按需打开 `SKILL.md`，不要一次性加载整个 skill 仓库。 diff --git a/.codex/skills/doc/SKILL.md b/.codex/skills/doc/SKILL.md index 2307bf2..a41a263 100644 --- a/.codex/skills/doc/SKILL.md +++ b/.codex/skills/doc/SKILL.md @@ -7,7 +7,7 @@ description: 渐进式文档生成器。首次只写精炼梗概（≤300字） > **核心理念**：文档是缝缝补补长出来的，不是一步到位写出来的。首次只写最重要的梗概，后续通过讨论和迭代逐步完善。 -当用户调用 `doc` skill、`$doc`，或自然语言要求“用 doc 写文档”时，执行以下步骤： +当用户调用 `doc` skill、`/doc`、`$doc`，或自然语言要求“用 doc 写文档”时，执行以下步骤： ## 1. 理解需求 @@ -78,14 +78,14 @@ author: {作者署名} 文档: {标题} | 版本: v1.0 | 路径: {path} 字数: ~{N}字（首版梗概） -后续可以通过 $doc 继续补充完善。 +后续可以通过 /doc 继续补充完善。 主人，用不用我沉淀 or git 提交？ ``` ## 工作流总览 ```text -$doc <指令> +/doc <指令> │ ├── 1. 理解需求（简短确认主题、路径、署名） ├── 2. 快速调研（聚焦核心，不求全面） diff --git a/AGENTS.md b/AGENTS.md index 7bebe50..e76cc98 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -31,7 +31,7 @@ - Discovery: 以上列表就是当前仓库提供给 Codex 的 skills。 - Trigger rules: 如果用户显式提到 skill 名称（例如 `/rr`、`$rr`、`rr skill`、`用 rr 评审`），或任务明显匹配 skill 描述，优先使用对应 skill。 -- Codex usage: 在 Codex 中优先使用 `/skill-name`、`$skill-name` 或自然语言触发 skill。 +- Codex usage: 在 Codex 中优先使用 `/skill-name`；兼容历史 `$skill-name` 写法，也支持自然语言触发。 - Missing/blocked: 如果某个 skill 文件不存在或无法读取，简短说明并回退到普通实现方式。 - Context hygiene: 只按需打开 `SKILL.md`，不要一次性加载整个 skill 仓库。 diff --git a/AGENTS.md.template b/AGENTS.md.template index 4466085..512dc98 100644 --- a/AGENTS.md.template +++ b/AGENTS.md.template @@ -35,7 +35,7 @@ - Discovery: 以上列表就是当前项目注册给 Codex 的 skills。 - Trigger rules: 如果用户显式提到 skill 名称（例如 `/rr`、`$rr`、`rr skill`、`用 rr 评审`），或任务明显匹配 skill 描述，优先使用对应 skill。 -- Codex usage: 在 Codex 中优先使用 `/skill-name`、`$skill-name` 或自然语言触发 skill。 +- Codex usage: 在 Codex 中优先使用 `/skill-name`；兼容历史 `$skill-name` 写法，也支持自然语言触发。 - Missing/blocked: 如果某个 skill 文件不存在或无法读取，简短说明并回退到普通实现方式。 - Context hygiene: 只按需打开 `SKILL.md`，不要一次性加载整个 skill 仓库。 diff --git a/README.md b/README.md index 71ff8db..4d033c5 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ | 平台 | 安装目录 | 触发方式 | |------|----------|----------| | Claude Code | `.claude/skills/` | `/rr`、`/wp`、`/go` 这类 slash commands | -| Codex | `.codex/skills/` | `/rr`、`$rr`，或直接自然语言说明“用 rr skill 评审需求文档” | +| Codex | `.codex/skills/` | `/rr`、`/wp` 这类 slash commands，或直接自然语言说明“用 rr skill 评审需求文档” | > Codex 额外需要项目根目录存在 `AGENTS.md`。本仓库已提供 `AGENTS.md.template`，安装脚本在 Codex 模式下会自动生成。 @@ -25,30 +25,32 @@ RequirementsDoc ──▶ PRD ──▶ FeatureSummary ──▶ DevelopmentPlan | 类型 | Skill | Claude Code | Codex | 描述 | |------|-------|-------------|-------|------| -| **Review** | `rr` | `/rr` | `$rr` | 评审 RequirementsDoc.md | -| | `rp` | `/rp` | `$rp` | 评审 PRD.md | -| | `rf` | `/rf` | `$rf` | 评审 FeatureSummary.md | -| | `rd` | `/rd` | `$rd` | 评审 DevelopmentPlan.md | -| | `ru` | `/ru` | `$ru` | 评审 UIDesign.md | -| | `rt` | `/rt` | `$rt` | 评审 tasks.md | -| **Write** | `wp` | `/wp` | `$wp` | 从 RequirementsDoc 生成 PRD | -| | `wf` | `/wf` | `$wf` | 从 PRD 生成 FeatureSummary | -| | `wd` | `/wd` | `$wd` | 从 FeatureSummary 生成 DevelopmentPlan | -| | `wu` | `/wu` | `$wu` | 从 DevelopmentPlan 生成 UIDesign | -| | `wt` | `/wt` | `$wt` | 从 DevelopmentPlan 生成 tasks | -| **Modify** | `mr` | `/mr` | `$mr` | 增量修改 RequirementsDoc | -| | `mp` | `/mp` | `$mp` | 增量修改 PRD（自动读取评审报告） | -| | `mf` | `/mf` | `$mf` | 增量修改 FeatureSummary | -| | `md` | `/md` | `$md` | 增量修改 DevelopmentPlan | -| | `mu` | `/mu` | `$mu` | 增量修改 UIDesign | -| | `mt` | `/mt` | `$mt` | 增量修改 tasks | -| **执行** | `go` | `/go` | `$go` | 🚀 发射按钮，激进模式一口气完成开发 | -| **辅助** | `iter` | `/iter` | `$iter` | 迭代变更入口（Bug/功能/重构） | -| | `doc` | `/doc` | `$doc` | 渐进式文档生成器，先写梗概再迭代完善 | -| | `update` | `/up` | `$update` 或 `$up` | Skill 升级优化 | -| | `deploy` | `/deploy` | `$deploy` | Drone CI/CD 全流程部署引导 | -| | `issue` | `/issue` | `/issue` 或 `$issue` | 通用 Gitea issue 查询（列表 + 单条详情） | -| | `changelog` | `/changelog` | `$changelog` | 一键发版（日志 + commit + tag） | +| **Review** | `rr` | `/rr` | `/rr` | 评审 RequirementsDoc.md | +| | `rp` | `/rp` | `/rp` | 评审 PRD.md | +| | `rf` | `/rf` | `/rf` | 评审 FeatureSummary.md | +| | `rd` | `/rd` | `/rd` | 评审 DevelopmentPlan.md | +| | `ru` | `/ru` | `/ru` | 评审 UIDesign.md | +| | `rt` | `/rt` | `/rt` | 评审 tasks.md | +| **Write** | `wp` | `/wp` | `/wp` | 从 RequirementsDoc 生成 PRD | +| | `wf` | `/wf` | `/wf` | 从 PRD 生成 FeatureSummary | +| | `wd` | `/wd` | `/wd` | 从 FeatureSummary 生成 DevelopmentPlan | +| | `wu` | `/wu` | `/wu` | 从 DevelopmentPlan 生成 UIDesign | +| | `wt` | `/wt` | `/wt` | 从 DevelopmentPlan 生成 tasks | +| **Modify** | `mr` | `/mr` | `/mr` | 增量修改 RequirementsDoc | +| | `mp` | `/mp` | `/mp` | 增量修改 PRD（自动读取评审报告） | +| | `mf` | `/mf` | `/mf` | 增量修改 FeatureSummary | +| | `md` | `/md` | `/md` | 增量修改 DevelopmentPlan | +| | `mu` | `/mu` | `/mu` | 增量修改 UIDesign | +| | `mt` | `/mt` | `/mt` | 增量修改 tasks | +| **执行** | `go` | `/go` | `/go` | 🚀 发射按钮，激进模式一口气完成开发 | +| **辅助** | `iter` | `/iter` | `/iter` | 迭代变更入口（Bug/功能/重构） | +| | `doc` | `/doc` | `/doc` | 渐进式文档生成器，先写梗概再迭代完善 | +| | `update` | `/up` | `/up` | Skill 升级优化 | +| | `deploy` | `/deploy` | `/deploy` | Drone CI/CD 全流程部署引导 | +| | `issue` | `/issue` | `/issue` | 通用 Gitea issue 查询（列表 + 单条详情） | +| | `changelog` | `/changelog` | `/changelog` | 一键发版（日志 + commit + tag） | + +> Codex 兼容历史 `$skill` 写法，但本文档统一以 `/skill` 作为主入口。 ## 安装 & 更新 @@ -114,11 +116,11 @@ Claude Code: Codex: ```text -$wp -$wf -$wd -$wt -$go +/wp +/wf +/wd +/wt +/go ``` ### 1->100 阶段：持续迭代 @@ -133,8 +135,8 @@ Claude Code: Codex: ```text -$iter -$go +/iter +/go ``` 也可以直接说自然语言，例如： @@ -169,10 +171,6 @@ Codex: /issue https://git.example.com/owner/repo /issue https://git.example.com/owner/repo --state=all --limit=20 /issue https://git.example.com/owner/repo 7 - -$issue https://git.example.com/owner/repo -$issue https://git.example.com/owner/repo --state=all --limit=20 -$issue https://git.example.com/owner/repo 7 ``` ### 工作流总览