Files
image-gen-custom-skill/README.md
T
2026-09-05 21:08:13 +08:00

97 lines
2.2 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.
# image-gen-custom-project
这是一个面向 Codex 的本地技能包仓库,核心内容是 `image-gen-custom`:它通过兼容 OpenAI 的 Images API 生成图片,并把结果稳定地保存为本地 `PNG`、`JPEG`、`GIF` 或 `WebP` 文件。
## 仓库内容
```text
skill/image-gen-custom/
├─ SKILL.md
├─ agents/openai.yaml
└─ scripts/
├─ configure.ps1 / configure.sh
├─ generate-image.ps1 / generate-image.sh
├─ install-skill.ps1 / install-skill.sh
└─ 其他辅助脚本
```
## 主要能力
- 支持自定义 OpenAI-compatible API base URL
- 支持指定模型、尺寸、质量和输出路径
- 自动校验返回内容是否为有效图片
- 以原子写入方式保存输出文件
- Windows 上使用 DPAPI 保存密钥,macOS/Linux 使用系统 keyring
## 安装
在对应平台运行安装脚本:
```powershell
skill\image-gen-custom\scripts\install-skill.ps1
```
```bash
bash skill/image-gen-custom/scripts/install-skill.sh
```
如需覆盖已有安装,可加 `-Force` 或 `--force`。
## 配置
首次使用前先配置 API 基础地址和密钥:
```powershell
skill\image-gen-custom\scripts\configure.ps1
```
```bash
bash skill/image-gen-custom/scripts/configure.sh
```
也可以临时使用环境变量:
- `OPENAI_API_KEY`
- `OPENAI_BASE_URL`
## 生成图片
Windows:
```powershell
skill\image-gen-custom\scripts\generate-image.ps1 `
-Prompt "A concise prompt..." `
-Out "outputs\generated-image.png" `
-Size "1024x1024" `
-Quality "low" `
-Force
```
macOS / Linux:
```bash
bash skill/image-gen-custom/scripts/generate-image.sh \
--prompt "A concise prompt..." \
--out outputs/generated-image.png \
--size 1024x1024 \
--quality low \
--force
```
默认模型是 `gpt-image-2`,可通过 `-Model` / `--model` 覆盖。
## 运行时说明
- 图片 API 支持 `b64_json` 或图片 URL 返回
- URL 下载上限为 50 MB
- 输出会先写入临时文件,再替换到目标路径
- 可通过 `CODEX_IMAGEGEN_VENV` 指定私有虚拟环境位置
- 可通过 `CODEX_IMAGEGEN_PYTHON` 指定用于引导环境的 Python
## 安全提示
- 不要把密钥写进脚本、提交记录或这个 README
- Windows 密钥保存到 DPAPI 保护的本地文件
- 其他平台保存到系统 keyring