Files
easyai-codex-plugins/README.md
T

158 lines
4.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# EasyAI Codex Plugins
EasyAI 团队的 Codex 插件市场。目前包含:
- `easyai-product-intake`(界面名称:**EasyAI 提需求/报 Bug**):引导产品经理补齐需求或 Bug 信息,在明确确认后提交到飞书多维表格。
仓库公开可读,产品经理无需 Gitea 账号即可查看或下载。提交飞书任务仍然必须使用本人已授权的飞书身份;公开仓库不会授予任何飞书数据访问权限。
## 产品经理:首次安装
### 1. 检查命令
打开终端,确认 Codex CLI 和飞书 CLI 可用:
```bash
codex --version
lark-cli --version
```
如果任一命令不存在,请联系 EasyAI 自动化管理员完成对应客户端安装,不要从非公司渠道下载替代程序。
### 2. 添加团队插件市场
```bash
codex plugin marketplace add https://git.51easyai.com/cc/easyai-codex-plugins.git --ref main
```
检查是否已添加成功:
```bash
codex plugin marketplace list
```
输出中应包含市场名 `easyai-team`
### 3. 安装插件
```bash
codex plugin add easyai-product-intake@easyai-team
```
也可以在 Codex CLI 输入 `/plugins`,切换到 `EasyAI Team`,找到 **EasyAI 提需求/报 Bug** 后安装。
安装完成后,重新启动 Codex 桌面应用或开启一个新任务;已打开的旧任务不会自动加载新插件。
### 4. 检查飞书身份
```bash
LARKSUITE_CLI_NO_UPDATE_NOTIFIER=1 \
LARKSUITE_CLI_NO_SKILLS_NOTIFIER=1 \
lark-cli auth status --json --verify
```
如果用户身份显示为未授权或已过期,运行:
```bash
lark-cli auth login --domain base
```
根据终端给出的链接在浏览器中完成飞书授权。插件始终使用当前产品经理本人的飞书身份,不接受也不需要在对话中提供 Token、Cookie 或密码。
如果提示 lark-cli 尚未初始化,先运行:
```bash
lark-cli config init --new
```
完成公司飞书应用配置后,再重新执行身份授权。若没有应用配置权限,请联系 EasyAI 自动化管理员。
## 产品经理:提交需求或 Bug
在一个新的 Codex 任务中直接输入,例如:
```text
提一个需求:在订单详情页显示预计完成时间。
```
或者:
```text
报一个 Bug:测试环境中,用户修改头像后页面仍然显示旧头像。
```
插件会:
1. 判断是需求还是 Bug。
2. 每轮最多追问 3 个会影响执行或验收的问题。
3. 展示结构化预览。
4. 等待你明确回复“确认提交”。
5. 使用你的飞书身份创建记录,并返回记录链接和提交幂等键。
没有明确确认时,插件不会写入飞书。任务状态、执行阶段、代码分支、PR、部署和审计字段由中央流水线维护,产品经理无需编辑。
## 更新插件
管理员发布新版本后,运行:
```bash
codex plugin marketplace upgrade easyai-team
codex plugin add easyai-product-intake@easyai-team
```
然后重新启动 Codex 桌面应用或开启一个新任务。
## 卸载
```bash
codex plugin remove easyai-product-intake@easyai-team
codex plugin marketplace remove easyai-team
```
卸载插件不会删除已经提交到飞书的任务,也不会自动撤销飞书服务端授权。如需撤销授权,请在飞书的授权管理页面操作。
## 直接下载
- 仓库页面:<https://git.51easyai.com/cc/easyai-codex-plugins>
- 固定版本下载:<https://git.51easyai.com/cc/easyai-codex-plugins/releases>
- Git 克隆:`https://git.51easyai.com/cc/easyai-codex-plugins.git`
- `main` 分支 ZIP<https://git.51easyai.com/cc/easyai-codex-plugins/archive/main.zip>
直接下载适合查看或归档;日常安装建议使用上面的 Codex 插件市场命令,以便后续升级。
## 管理员:发布新版本
1. 修改插件内容并完成本地测试。
2. 使用 plugin-creator 的 cachebuster 工具更新插件清单版本。
3. 校验插件和 Skill
```bash
python3 /Users/easyai/.codex/skills/.system/plugin-creator/scripts/validate_plugin.py \
plugins/easyai-product-intake
python3 /Users/easyai/.codex/skills/.system/skill-creator/scripts/quick_validate.py \
plugins/easyai-product-intake/skills/easyai-submit-task
```
4. 提交并推送 `main`。
5. 在一台未安装该版本的测试机上执行“首次安装”步骤。
6. 用新的 Codex 任务分别完成一次需求预览和 Bug 预览;真实写入测试必须使用专门的测试记录。
7. 通知产品经理运行“更新插件”命令。
不要把飞书 App Secret、访问令牌、Cookie、个人凭据或生产环境密码提交到本仓库。
## 目录结构
```text
.
├── .agents/plugins/marketplace.json
└── plugins/
└── easyai-product-intake/
├── .codex-plugin/plugin.json
└── skills/easyai-submit-task/
```
## 使用范围
本仓库用于 EasyAI 团队内部工作流分发。仓库虽然公开可读,但未向第三方授予开源许可。