🎨 indesign-cli

中文 | English

让 AI Agent 直接操作 Adobe InDesign 的命令行工具。

indesign-cli 把 InDesign 的自动化能力包装成 Agent 友好的 CLI：Agent 可以查询工具、执行 JSX 脚本、调用排版能力、验证导出文件，并按需配合项目级 Skill 使用。

当前 CLI 可发现 约 150 个可调用能力（以 tool domains 实时输出为准），覆盖 InDesign 绝大部分常用自动化功能：文档、页面、跨页、母版、图层、文本、图片、基础图形、样式、导出、Book、Presentation、模板槽位、脚本执行和环境检查。

如果你正在做 AI 生成画册、建筑汇报、品牌手册、版式模板、HTML 转 InDesign 这类项目，它可以让 Agent 不再靠“猜坐标”和“手搓脚本”工作，而是通过稳定的命令和结构化返回值操作真实 InDesign。

✨ 这个项目解决什么问题？

Adobe InDesign 很强，但对 AI Agent 来说并不好用：

• 工具能力多，Agent 不知道该调用哪个。
• JSX 脚本可以执行，但调试、传参、返回值和错误处理都很散。
• MCP 工具很多，直接塞进上下文会占用大量 token。
• 真实导出物是否成功，不能只靠“命令没报错”判断。

indesign-cli 做的事情很简单：把真实 InDesign 自动化能力变成 Agent 更容易使用的一组命令。

它的关键价值之一是 省 token：Agent 不需要一次性读取上百个工具的完整描述，可以先看 tool domains 的摘要，再用 tool search、tool list、tool schema 按需加载当前任务需要的工具说明。输出默认是紧凑单行 JSON，需要人工查看时加 --pretty。

它不是一个给人类手动排版的 CLI，也不是一个新的排版引擎。它更像是 AI 项目和 InDesign 之间的稳定桥梁。

🚀 快速安装

1. 准备环境

你需要：

• Windows
• Adobe InDesign 桌面版：推荐 2024-2026；CLI 会尝试连接 2022-2026、CC 版本和通用 InDesign.Application COM 入口，实际可用版本取决于本机 COM 注册
• Node.js 18+
• Python 3.10+

InDesign 需要和命令行运行在同一个 Windows 用户会话中。

2. 从 PyPI 安装

pip install indesign-cli

3. 安装 Node 依赖

indesign-cli server setup

这一步会安装 InDesign 自动化所需的 Node 依赖，包括 winax。

4. 检查环境

indesign-cli --pretty server health --deep --connect-indesign

如果返回 ok: true 且 data.indesign_com.checked 为 true，真实 InDesign COM 链路已完成只读探针。

5. 常见环境问题排查

server health 的输出包含工具链诊断：python（解释器、用户包目录、包位置）、node / npm（路径和版本）、server_root（路径来源和长路径风险）、当前目录是否 UNC。排查环境问题先看这份输出。

ModuleNotFoundError: No module named 'cli_anything'

命令入口 indesign-cli.exe 和 Python 用户包目录不一致，常见于沙箱或受控 Agent 运行时重定向了 APPDATA / USERPROFILE。检查用户包目录：

python -c "import site; print(site.getuserbase()); print(site.getusersitepackages())"

如果指向临时目录，把 PYTHONUSERBASE 固定到真实用户目录或稳定短路径，再重新 pip install indesign-cli。

winax 编译失败（如 error C1083）

server setup 需要用 MSVC 编译原生模块 winax，在超长路径（深层临时目录）下容易失败。解决方式是把 server 目录固定到稳定短路径：

# 1. 定位当前 server 目录
python -c "from cli_anything.indesign.core.runtime import resolve_server_root; print(resolve_server_root())"
# 2. 把整个目录复制到短路径，例如 D:\indesign-cli-server
# 3. 指向它并重装依赖
setx INDESIGN_CLI_SERVER_ROOT "D:\indesign-cli-server"
indesign-cli server setup

INDESIGN_CLI_SERVER_ROOT 必须指向包含 package.json、src/index.js、src/advanced/index.js 的目录。这也是推荐的预构建模式：winax 构建一次，多个会话和受控环境复用，不必每次临时编译。

npm 不可用（Volta / nvm shim 损坏）

server setup 会先探测 PATH 上的 npm；探测失败时自动回退到 Node 自带的 npm-cli.js。两者都不可用时报 NPM_NOT_AVAILABLE，需要先修复本机 Node / npm 安装。

🧠 手动安装 Agent Skill

如果你希望某个项目里的 Agent 自动知道如何使用 indesign-cli，需要手动复制 Skill 文档。

Skill 源文件在仓库中：

skills/indesign-cli/SKILL.md

如果你是通过 PyPI 安装的 CLI，可以先定位包内副本：

python -c "from cli_anything.indesign.core.runtime import skill_source_path; print(skill_source_path())"

把这个文件手动复制到目标项目：

D:\AI\your-project\.codex\skills\indesign-cli\SKILL.md

CLI 不再提供自动复制 Skill 的命令。复制完成后，该项目中的 Agent 才会获得这套 InDesign CLI 使用说明。

🧩 插件接入

indesign-cli 支持项目级插件，让上层项目把自己的高层能力接入统一工具目录。比如 HTML-to-InDesign 项目可以注册 html 域，Agent 再通过同一套 tool list/schema/call 使用它。

本地插件接入示例：

indesign-cli plugin install D:\AI\html-indesign
indesign-cli plugin validate D:\AI\html-indesign
indesign-cli plugin doctor html-indesign
indesign-cli tool list --domain html

插件工具不会默认挤进 Agent 上下文。Agent 仍然先看 domain 摘要，再按需读取具体 schema。

🛠️ 常用能力

🔎 查询可用工具

indesign-cli tool domains
indesign-cli tool search --query "pdf"
indesign-cli tool list --domain template
indesign-cli tool schema template.populate_template_slots

Agent 可以先查有哪些工具，再只读取需要的 schema，减少上下文浪费。

🧰 能力覆盖

当前 indesign-cli 可发现 约 150 个可调用能力（随版本增长，以 tool domains 实时输出为准），覆盖 InDesign 绝大部分常用自动化功能，以及大多数 Agent 自动化场景：

• 文档、页面、跨页、母版、图层
• 文本框、表格、图片、基础图形、页面对象
• 段落样式、字符样式、对象样式、色板
• PDF / IDML / 图片导出与产物验证
• Book、Presentation、模板槽位和高级模板填充
• JSX 脚本执行、session 线索和环境检查

这些能力通过 CLI 分域查询，不会一次性占满 Agent 上下文。

📜 执行 JSX 脚本

indesign-cli --pretty script run test\workspace\probe.jsx

适合测试真实 InDesign 行为、创建文档、检查对象、执行复杂排版逻辑。

复杂构建或导出可能超过默认等待时间，可以显式加长脚本通道超时（script run 默认 300 秒；tool call 默认 30 秒）：

indesign-cli --pretty script run test\workspace\build.jsx --timeout-ms 900000

短脚本也可以从 stdin 输入：

Get-Content test\workspace\probe.jsx | indesign-cli --pretty script run --stdin

📦 验证导出物

indesign-cli export verify output\deck.pdf

用于确认 PDF、IDML 等文件真的生成成功，而不是只看命令是否结束。

export_images 当前只声明并支持 JPEG。传入 PNG/TIFF 会返回 ARTIFACT_FORMAT_UNSUPPORTED，避免生成误导性的 .jpg 产物。

🛡️ 文档关闭安全

document.close_document 默认不会在多文档场景关闭 activeDocument。如果确实要关闭本轮创建的测试文档，参数必须显式包含 expectedDocumentName 或 forceActiveDocument:true；如需丢弃未保存修改，还必须传 allowDiscard:true。

🧩 使用模板槽位

indesign-cli tool call template.list_template_blueprints --args-file args.json
indesign-cli tool call template.inspect_template_blueprint --args-file args.json
indesign-cli tool call template.create_page_with_template --args-file args.json
indesign-cli tool call template.populate_template_slots --args-file args.json

适合让 Agent 基于母版、脚本标签和槽位名生成稳定页面。

📚 Book / Presentation 工具

indesign-cli 也包含 Book 和 Presentation 相关能力，例如：

• 创建和管理 InDesign Book
• 导出 Book
• 创建演示型文档
• 添加封面页、章节页、全幅图片页、图片网格页

这些能力可以通过 tool domains、tool list 和 tool schema 查询。

🚨 常见错误码速查

所有命令（含参数拼写错误）都返回统一 JSON envelope（schema_version: 2），失败时看 error.code、error.message 和 error.hint。高频错误码：

错误码	含义	典型处置
BAD_CLI_ARGS	命令行参数缺失或拼错	看 error.details.usage，或跑对应 --help
ARGS_REQUIRED / ARGS_FILE_NOT_FOUND / ARGS_JSON_INVALID / ARGS_NOT_OBJECT	工具参数缺失或 JSON 无效	用 --args-file 传 UTF-8 JSON 文件，或 --args - 走 stdin
ARGS_UNKNOWN_KEY	参数名拼错	按 error.details.allowed 修正键名
TOOL_NOT_FOUND / DOMAIN_NOT_FOUND	工具或域不存在	先 tool domains，再 tool search --query <关键词>
MISSING_ARGUMENT	缺必填参数	tool schema <tool_id> 查看必填项
BAD_TIMEOUT / TIMEOUT	超时参数非法 / 执行超时	超时值范围 1-3600 秒；TIMEOUT 后先跑 session doctor 再重试
BATCH_PLAN_* / BATCH_STEP_INVALID / BATCH_STEP_FAILED	batch plan 格式或步骤失败	按 error.details.expected_step 修正 plan
MCP_START_FAILED / MCP_TOOL_FAILED / INDESIGN_SCRIPT_FAILED	Node 后端或 InDesign 脚本失败	跑 server health 排查；看 error.details.result
NO_ACTIVE_DOCUMENT	没有打开的文档	先打开或创建文档
ARTIFACT_*	导出物验证失败	确认导出成功、路径正确、产物非旧文件
SERVER_ROOT_* / NPM_*	环境或依赖问题	见上文"常见环境问题排查"
UNEXPECTED_ERROR	CLI 未预期异常	带 error.details（含异常类型和位置）反馈

🧪 示例工作流

一个典型 Agent 流程可能是：

indesign-cli server health --deep --connect-indesign
indesign-cli tool domains
indesign-cli tool search --query "template"
indesign-cli tool schema template.populate_template_slots
indesign-cli tool explain template.populate_template_slots
indesign-cli script run test\workspace\build.jsx
indesign-cli session doctor
indesign-cli export verify output\presentation.pdf

Agent 负责生成脚本和参数，indesign-cli 负责把它们安全地送进真实 InDesign，并返回结构化结果。

💡 适合谁使用？

适合：

• 想让 AI Agent 自动操作 InDesign 的开发者
• 正在做 HTML / JSON / 模板到 InDesign 的转换项目
• 需要自动生成设计汇报、画册、排版文档的团队
• 希望用脚本验证真实 InDesign 输出的 Agent 工作流

不适合：

• 只想手动点按钮排版的普通 InDesign 用户
• 不安装 Adobe InDesign 的纯后端环境
• 希望用它替代浏览器、LaTeX 或其他排版引擎的场景

🔧 本地开发

git clone https://github.com/zhanglongxiao111/indesign-cli.git
cd indesign-cli
pip install -e .
indesign-cli server setup
indesign-cli server health --deep

运行测试：

python -m pytest agent-harness\cli_anything\indesign\tests\test_core.py -q
node scripts\validate_schemas.js
node scripts\check_duplicates.mjs
node tests\index.js --required

📁 项目结构

.
├─ agent-harness/   # Python CLI、CLI 测试
├─ src/             # MCP Server、InDesign handler、JSX/COM 执行链路
├─ scripts/         # 维护脚本和检查脚本
├─ tests/           # 测试和真实 InDesign E2E
├─ docs/            # 设计文档、计划、协作记录
├─ skills/          # 可手动复制到其他项目的 Agent Skill 和预览资产
├─ pyproject.toml   # pip 安装入口
└─ AGENTS.md        # 项目级 Agent 协作规则

🗺️ 下一步方向

项目后续会重点完善：

• 更稳定的 HTML / 语义模板到 InDesign 转换链路
• 更好用的模板槽位协议
• 更适合 Agent 的排版检查和导出验证
• 更完善的示例项目和真实 E2E 场景

📄 License

MIT