快速开始
命令行工具 (CLI)
使用 JSON 从命令行生成 Office 文件
office-open 包包含一个命令行工具，可从 JSON 文件或 JSON 字符串生成文档。
安装
命令行工具随 office-open 包一起安装：
pnpm add office-open
用法
office-open <类型> <输入> [输出]
- 类型 — 文档类型：
docx、pptx或xlsx - 输入 — JSON 字符串或 JSON 文件路径
- 输出 — 输出文件路径（默认：
output.<ext>）
选项
| 参数 | 别名 | 说明 |
|---|---|---|
--input-file | -i | 从文件读取 JSON |
--output-file | -o | 输出文件路径 |
--help | -h | 显示帮助 |
--version | -v | 显示版本 |
示例
从 JSON 文件生成
office-open docx input.json "我的文档.docx"
使用参数
office-open pptx -i slides.json -o "演示文稿.pptx"
内联 JSON
office-open docx '{"sections":[{"children":[{"paragraph":{"children":["你好，世界！"]}}]}]}' "output.docx"
JSON 格式
每种文档类型有各自的必需结构。命令行工具会在生成前根据对应 schema 验证输入。
DOCX
{
"sections": [
{
"children": [{ "paragraph": { "children": [{ "text": "你好，世界！", "bold": true }] } }]
}
]
}
PPTX
{
"title": "我的演示文稿",
"slides": [
{
"children": [
{
"shape": {
"x": 100,
"y": 100,
"width": 760,
"height": 340,
"textBody": { "children": [{ "text": "你好，世界！", "fontSize": 32 }] }
}
}
]
}
]
}
XLSX
{
"worksheets": [
{
"name": "Sheet1",
"rows": [
{ "cells": [{ "value": "姓名" }, { "value": "分数" }] },
{ "cells": [{ "value": "张三" }, { "value": 95 }] }
]
}
]
}
验证
命令行工具会在生成前验证 JSON 输入。如果输入无效，会给出具体的错误位置和原因：
Error: Invalid docx options at "sections.0.children.0": Expected object, received string