Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .claude/commands/commit.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
name: "commit"
description: "提交当前变更到 Git"
usage: "/commit"
---

# Commit Command

提交当前变更到 Git。

**此命令已迁移到官方插件,将调用 `commit-commands` 插件。**
Expand Down
88 changes: 0 additions & 88 deletions .claude/commands/fix-permissions.md

This file was deleted.

10 changes: 10 additions & 0 deletions .claude/commands/test.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
---
name: "test"
description: "执行完整的测试流程"
usage: "/test"
---

# Test Command

## 功能说明

执行完整的测试流程,包括单元测试、构建验证和集成测试。

**用法:**
Expand Down
129 changes: 129 additions & 0 deletions .codex/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Codex 项目级 Prompts

本目录提供仓库内的 Codex prompts(用于生成/管理 slash 命令的文档版本)。
由于 Codex CLI 的自定义 prompts 只会从用户目录读取(默认 `~/.codex/prompts/`),
这里的内容需要手动安装到本地目录后才会生效。

## 安装到本地

运行安装脚本,将本目录的 prompts 复制到 `~/.codex/prompts/`:

```bash
bash .codex/scripts/install-prompts.sh
```

安装完成后,使用 `/prompts:<name>` 调用(例如:`/prompts:analyze-issue`)。

## 使用提示

- 这些 prompts 以"仓库根目录"为默认上下文。
- 作为全局 prompts 使用时,请先切换到目标仓库或显式指定路径(详见各命令文件中的"使用前:选择目标仓库")。

## Prompt 文件格式规范

本目录下的 prompts 采用混合格式,既符合 Codex 官方规范,又保留完整的使用示例:

### 混合格式(兼容官方标准)

```yaml
---
description: 命令的功能描述
usage: /prompts:command-name <参数>
argument-hint: <参数>
---
```

### 字段说明

- **description** (必需): 描述 prompt 的功能,使用中文
- **usage** (推荐): 完整的使用示例,包含命令名和参数
- 格式:`/prompts:command-name <参数>`
- 提供完整的调用示例供参考
- **argument-hint** (可选): 仅参数部分的描述(Codex 官方格式)
- 使用 `<param>` 表示必需参数
- 使用 `[param]` 表示可选参数
- 使用 `[--flag=<value>]` 表示可选标志参数
- 仅包含参数部分,不含命令名称

### 调用方式

- 在 Codex CLI 中使用 `/prompts:filename` 调用(不含 .md 扩展名)
- 例如:`/prompts:analyze-issue <issue-number>`

### 示例

**有参数的命令**:
```yaml
---
description: 分析 GitHub Issue 并创建需求分析文档
usage: /prompts:analyze-issue <issue-number>
argument-hint: <issue-number>
---
```

**有多个参数的命令**:
```yaml
---
description: 升级项目依赖
usage: /prompts:upgrade-dependency <package-name> <from-version> <to-version>
argument-hint: <package-name> <from-version> <to-version>
---
```

**无参数的命令**:
```yaml
---
description: 执行完整的测试流程
usage: /prompts:test
---
```

### 格式说明

- ✅ 兼容 Codex 官方格式(使用 `argument-hint`)
- ✅ 保留完整使用示例(使用 `usage`)
- ✅ 文件名即为 prompt 名称,无需 `name` 字段
- ✅ 所有字段值不使用引号

## 可用命令列表

所有命令都支持 Codex CLI(通过 `/prompts:command-name` 调用):

**任务管理**:
- `analyze-issue` - 分析 GitHub Issue 并创建需求分析文档
- `plan-task` - 设计技术方案并输出实施计划
- `implement-task` - 根据技术方案实施任务
- `review-task` - 审查任务实现并输出代码审查报告
- `refinement-task` - 处理代码审查反馈并修复问题
- `complete-task` - 标记任务完成并归档到 completed 目录
- `task-status` - 查看任务的当前状态和进度
- `block-task` - 标记任务阻塞并记录阻塞原因

**Git 操作**:
- `commit` - 提交当前变更到 Git(提供最佳实践指南)
- `create-pr` - 创建 Pull Request
- `sync-pr` - 将任务处理进度同步到 PR 评论
- `sync-issue` - 将任务处理进度同步到 Issue 评论
- `refine-title` - 重构 Issue/PR 标题为 Conventional Commits 格式

**依赖和安全**:
- `upgrade-dependency` - 升级项目依赖
- `analyze-security` - 分析 Dependabot 安全告警并创建修复任务
- `close-security` - 关闭 Dependabot 安全告警(需提供合理理由)

**其他**:
- `test` - 执行完整的测试流程

## 常见问题

### Q: 为什么我无法使用 `/commit-commands:commit`?

A: 这是 Claude Code 的官方插件命令,在 Codex CLI 中不可用。请使用 `/prompts:commit` 查看提交指南,然后手动执行 Git 命令。

### Q: 如何进行代码审查?

A: 使用 `/prompts:review-task <task-id>` 查看详细的审查清单,然后按照清单手动审查代码。Claude Code 用户可以使用 `/code-review:code-review` 进行自动审查。

### Q: 命令文件中提到的插件功能我能用吗?

A: 如果命令文件中标记为"Claude Code 插件"或"Codex CLI 不支持",则这些功能仅适用于 Claude Code。请使用文档中提供的替代方法(通常是手动操作步骤)。
Loading