官方原文索引: Plugins – Codex / Build plugins
1. 核心架构与原理解析
Plugin 是 Skill 的分发单元,支持跨仓库、跨团队共享:
| 层级 | 范围 | 分发方式 |
|---|---|---|
| Prompt | 单次会话 | 复制粘贴 |
| Skill | 个人/项目 | 文件系统 |
| Plugin | 团队/社区 | npm 包 / Git 子模块 |
Plugin 标准结构:
2. 工程落地与代码示例
创建 Plugin
# 初始化 Plugin 项目
mkdir codex-plugin-mycompany && cd codex-plugin-mycompany
npm init -y
# 目录结构
mkdir -p skills rules// package.json
{
"name": "@mycompany/codex-plugin",
"version": "1.0.0",
"description": "MyCompany 的 Codex 插件,包含安全审查和代码规范 Skill",
"codex": {
"skillsDir": "./skills",
"rulesDir": "./rules"
},
"keywords": ["codex", "plugin", "security", "review"],
"license": "MIT"
}<!-- skills/enterprise-security.md -->
---
name: enterprise-security
description: 企业级安全审查清单,符合 ISO 27001 要求
---
## 认证与授权
- [ ] 所有端点都有认证检查(除公开端点)
- [ ] 权限校验在服务端完成,不依赖前端
- [ ] 敏感操作需要二次确认或 MFA
## 数据保护
- [ ] 传输层加密(HTTPS/TLS 1.3)
- [ ] 敏感字段加密存储(AES-256-GCM)
- [ ] 密钥通过 KMS/HSM 管理,不硬编码
## 输入验证
- [ ] 所有用户输入经过白名单校验
- [ ] 文件上传限制类型和大小
- [ ] 防 SQL 注入(参数化查询)
- [ ] 防 XSS(输出转义)
## 日志与监控
- [ ] 安全事件记录(登录失败、权限越权)
- [ ] 日志不可篡改(WORM 存储)
- [ ] 异常行为告警(暴力破解、数据爬取)# rules/security.rules
# 企业安全规则
prefix_rule(
pattern = ["eval", "*"],
decision = "block",
justification = "禁止 eval 动态执行"
)
prefix_rule(
pattern = ["new", "Function"],
decision = "block",
justification = "禁止 Function 构造函数"
)
prefix_rule(
pattern = ["child_process", "exec"],
decision = "require_approval",
justification = "命令执行需要审批"
)安装与配置 Plugin
# 本地安装
codex plugin install /path/to/codex-plugin-mycompany
# npm 安装
codex plugin install @mycompany/codex-plugin
# GitHub 直接安装
codex plugin install github:mycompany/codex-plugin
# 配置激活(config.toml)
```toml
[plugins]
enabled = ["@mycompany/codex-plugin"]Plugin 发布到 npm
# 1. 登录 npm
npm login
# 2. 发布
npm publish --access public
# 3. 版本更新
npm version patch # 或 minor/major
npm publish3. 场景深入:Plugin 生态建设
场景:企业内部 Plugin Registry
场景:Plugin 版本兼容性管理
// package.json
{
"name": "@mycompany/codex-plugin",
"version": "2.0.0",
"codex": {
"minCodexVersion": "0.130.0",
"skillsDir": "./skills"
},
"peerDependencies": {
"@openai/codex": ">=0.130.0"
}
}4. 💡 核心避坑与最佳实践 (Takeaways)
- Plugin 版本锁定:团队使用固定版本,防止上游更新破坏工作流
- 私有 Registry:企业 Plugin 通过私有 npm registry 或 Git 子模块分发
- 文档即契约:Plugin 的 README 必须包含 Skill 列表、参数说明、适用场景
- 渐进式推广:先在试点团队验证,再推广至全公司
- CI 测试 Plugin:发布前自动化测试所有 Skill 的可用性
- 语义化版本: breaking change 升 major,新 Skill 升 minor,bugfix 升 patch