diff --git a/README.md b/README.md index cb43befe4..cb1c563e6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # EAPIL Codex 插件市场 -这是 EAPIL 维护的 Codex 插件市场。首要用途是让 AI agent 能稳定安装公共 skills、MCP 插件和第三方 Codex plugin。 +这是 EAPIL Codex 插件市场。首要用途是让 AI agent 能稳定安装公共 skills、MCP 插件和第三方 Codex plugin。 ## 给 AI 的安装流程 @@ -23,28 +23,6 @@ codex plugin add @eapil-skill-market codex plugin remove @eapil-skill-market ``` -## 本地调试安装 - -从本仓库 checkout 调试： - -```bash -codex plugin marketplace add . -codex plugin list --marketplace eapil-skill-market -codex plugin add docx@eapil-skill-market -``` - -临时干净环境验收： - -```bash -tmp_home="$(mktemp -d)" -CODEX_HOME="$tmp_home" codex plugin marketplace add /path/to/EapilSkillMarket -CODEX_HOME="$tmp_home" codex plugin list --marketplace eapil-skill-market -CODEX_HOME="$tmp_home" codex plugin add @eapil-skill-market -CODEX_HOME="$tmp_home" codex plugin remove @eapil-skill-market -CODEX_HOME="$tmp_home" codex plugin marketplace remove eapil-skill-market -rm -rf "$tmp_home" -``` - ## MCP 插件 当前公开 MCP 插件是 `mcp-playwright`。 @@ -65,7 +43,7 @@ enabled = true ## 官方插件能力 -本市场按 Codex 官方插件能力校验和发布，插件可以包含： +本市场中的插件可以包含 Codex 官方支持的这些能力： - `skills`：`./skills/` 下的一个或多个 `SKILL.md`。 - `mcpServers`：通常是 `./.mcp.json`，允许 MCP-only 插件。 @@ -73,63 +51,4 @@ enabled = true - `hooks`：插件作用域 Codex hooks，可为路径、路径数组、inline object 或 object 数组。 - `interface` / `assets`：`interface.logo`、`interface.composerIcon`、`interface.screenshots` 可引用插件内 `assets/` 文件或公开 URL。 -市场校验器会检查 plugin id、manifest `name` 和目录名必须是 ASCII kebab-case；中文只能用于 `interface.displayName`、说明文案和分类等展示字段。 - -## 仓库结构 - -```text -.agents/plugins/marketplace.json -plugins/codex/ - .agents/plugins/marketplace.json - plugins// - .codex-plugin/plugin.json - skills//SKILL.md # 可选 - .mcp.json # 可选 - .app.json # 可选 - hooks/ # 可选 - assets/ # 可选 -config/external-sources.json -scripts/validate_marketplace.py -``` - -## 维护规则 - -- README 正文统一使用简体中文；插件 ID、命令、配置键和上游专有名称保留原文。 -- 日常发布保留普通线性 Git 历史，使用普通 `git add -A`、`git commit`、`git push`，让 Codex marketplace 刷新获得增量传输收益。 -- 只有误同步大文件或用户明确要求历史清理时，才做一次性历史压缩。 -- 每次新增、替换、重命名、移除 public skill/plugin，或新增 hooks/MCP/apps/assets 等能力后，都要同步更新本 README 和 `plugins/codex/README.md`。 -- 不要同步 README-only 预览 GIF/截图。skill/reference 真正需要的图片保留并压缩为 WebP。 -- 第三方插件本地化写入 `config/external-sources.json` 的 `manifestOverrides` 和 `skillDescriptions`，不要直接手改生成 manifest。 -- 公共仓库只描述已发布插件，不写未发布能力、内部系统名、私有地址、鉴权方式或密钥来源。 - -## 第三方同步 - -第三方来源记录在 `config/external-sources.json`。 - -支持的适配器： - -- `codex-plugin`：上游已经是 Codex plugin。 -- `claude-skill`：上游是 Claude-style skill，会转换为 Codex plugin。 - -PowerShell 独立同步： - -```powershell -powershell -ExecutionPolicy Bypass -File .\scripts\sync_external_plugins.ps1 -``` - -带代理： - -```powershell -powershell -ExecutionPolicy Bypass -File .\scripts\sync_external_plugins.ps1 -Proxy http://127.0.0.1:2085 -``` - -## 发布前验证 - -```bash -python scripts/validate_marketplace.py -rg -n "|" README.md plugins/codex/README.md -``` - -对包含 `skills` 的插件，可额外运行系统 `validate_plugin.py`。不要用旧 validator 降级官方能力；MCP-only、app-only 或 hooks-only 插件以本仓库 marketplace 校验和 Codex 实装验收为准。 - -对新增插件，还要使用临时 `CODEX_HOME` 安装，并执行最小安全调用，证明 Codex 能加载该插件。MCP-only 插件至少要验证 marketplace list/add 成功，并检查 `.mcp.json` 已进入插件缓存；真实 MCP tool 调用可能依赖本地命令、浏览器权限或 token。 +安装时请使用 `codex plugin list --marketplace eapil-skill-market` 显示的 `plugin-id`；中文展示名不是安装 ID。 diff --git a/plugins/codex/README.md b/plugins/codex/README.md index e06f70dd8..685e2b723 100644 --- a/plugins/codex/README.md +++ b/plugins/codex/README.md @@ -15,13 +15,6 @@ codex plugin add @eapil-skill-market codex plugin marketplace add https://git.playones.com/arechen/EapilSkillMarket.git --ref main --sparse .agents --sparse plugins/codex ``` -从仓库根目录本地调试： - -```bash -codex plugin marketplace add . -codex plugin add docx@eapil-skill-market -``` - 每个 `plugins/` 目录都是一个可安装 Codex plugin。插件可以包含官方支持的 `skills`、`mcpServers`、`apps`、`hooks`、`interface` 和 `assets`。当前公开 MCP 插件是 `mcp-playwright`。 -完整插件清单、MCP 说明和维护规则见根目录 `README.md`。 +更多安装说明和公开插件说明见根目录 `README.md`。