92 lines
3.2 KiB
Markdown
92 lines
3.2 KiB
Markdown
# 技能安装与迁移说明
|
||
|
||
技能名称：**project-init-panel-deploy**
|
||
用途：自动化克隆、初始化、品牌化、Docker 部署开源项目，并强制改造成炫酷科技感玻璃面板风格 UI；
|
||
同时对齐《开源软件改造部署外包服务合同》的交付物与验收标准。
|
||
|
||
## 一、目录内容
|
||
|
||
```text
|
||
project-init-panel-deploy/
|
||
├── SKILL.md # 技能主文件（18 步工作流，必须先读）
|
||
├── references/
|
||
│ ├── panel-ui.md # 面板风格 UI 设计与验收规范
|
||
│ └── delivery-contract.md # 外包合同对齐的交付/验收规范
|
||
├── scripts/
|
||
│ ├── workflow_manager.py # 工作流状态管理（初始化/恢复/报告）
|
||
│ ├── panel_ui_audit.py # 阻断式面板 UI 自动审计
|
||
│ ├── deliverables_check.py # 交付物清单核查
|
||
│ └── build_delivery_package.py # 交付压缩包构建
|
||
├── requirements.txt # Python 第三方依赖
|
||
├── install.ps1 / install.sh # 一键安装脚本
|
||
└── INSTALL.md # 本文件
|
||
```
|
||
|
||
## 二、环境要求
|
||
|
||
- Python **3.9+**（推荐 3.11/3.12）
|
||
- Node.js 18+、pnpm、Docker / Docker Compose（执行实际项目部署时需要）
|
||
- ffmpeg（项目内含视频推流/转码时需要）
|
||
- 网络可访问目标 Git 仓库与 npm / pip / apt 源
|
||
|
||
## 三、安装步骤
|
||
|
||
### Windows（PowerShell）
|
||
|
||
```powershell
|
||
# 1. 复制整个技能目录到 Codex 技能目录
|
||
Copy-Item .\project-init-panel-deploy "$env:USERPROFILE\.codex\skills\" -Recurse -Force
|
||
|
||
# 2. 执行安装脚本（创建 venv 可选；安装 playwright）
|
||
.\project-init-panel-deploy\install.ps1
|
||
```
|
||
|
||
### macOS / Linux
|
||
|
||
```bash
|
||
# 1. 复制技能目录
|
||
cp -r ./project-init-panel-deploy ~/.codex/skills/
|
||
|
||
# 2. 执行安装脚本
|
||
bash ./project-init-panel-deploy/install.sh
|
||
```
|
||
|
||
> 若使用的是其他 Agent 框架，技能目录也可能是 `~/.agents/skills/`，按对应框架要求放置即可。
|
||
|
||
## 四、安装 Playwright 浏览器
|
||
|
||
UI 审计脚本需要 Playwright 的 Chromium 内核：
|
||
|
||
```bash
|
||
python -m pip install -r requirements.txt
|
||
python -m playwright install chromium
|
||
# Linux 如缺系统库，再执行：
|
||
python -m playwright install-deps chromium
|
||
```
|
||
|
||
## 五、验证安装
|
||
|
||
```bash
|
||
python ~/.codex/skills/project-init-panel-deploy/scripts/panel_ui_audit.py --help
|
||
python ~/.codex/skills/project-init-panel-deploy/scripts/workflow_manager.py --help
|
||
```
|
||
|
||
能正常打印帮助即安装成功。
|
||
|
||
## 六、使用方式
|
||
|
||
在 Codex 对话中用自然语言触发，例如：
|
||
|
||
- “初始化并部署项目，使用面板风格 UI <Git 仓库地址>”
|
||
- “克隆并改造这个开源项目，Docker 部署”
|
||
- “项目页面改版成科技感大屏风格”
|
||
|
||
Agent 会自动读取 `SKILL.md` 并按 18 步工作流执行，最终必须通过阻断式 UI 审计（0 violations）。
|
||
|
||
## 七、注意事项
|
||
|
||
- 技能脚本**不含任何硬编码本机路径**，可跨设备/跨平台直接迁移。
|
||
- 是否 `git push`、是否本地提交，严格以用户授权为准；用户要求“不推送代码”时禁止推送。
|
||
- 默认账号密码必须来自项目实际初始化逻辑，禁止猜测。
|
||
- 合同相关交付规范见 `references/delivery-contract.md`。
|