一键安装
Linux / macOS快速开始
1. 零配置解析(免登录, 每日 1000 页)
2. 付费 API(可选,支持更多格式和高级选项)
前往 TextIn 控制台 获取凭证(x-ti-app-id 和 x-ti-secret-code),然后运行:
~/.xparse-cli/config.yaml。
也可通过环境变量配置(适合 CI/CD):
命令一览
| 命令 | 说明 |
|---|---|
xparse-cli parse | 解析文档,输出 Markdown / JSON |
xparse-cli auth | 配置 API 凭证(交互式) |
xparse-cli config | 管理配置(show / set / reset / path) |
xparse-cli download | 下载解析结果中 elements 的图片 |
xparse-cli update | 自更新 CLI 到最新版本 |
xparse-cli version | 显示版本信息 |
parse 命令参数
| 参数 | 默认值 | 说明 |
|---|---|---|
--view | markdown | 输出视图:markdown、json |
--api | (auto) | API 模式:free、paid |
--page-range | 页码范围:"1-5" 或 "1-2,5-10" | |
--password | 加密文档密码 | |
--include-char-details | false | 返回字符级坐标和置信度 |
--list | 从文件读取输入列表(需配合 --output) | |
--output | (stdout) | 输出文件路径或目录(目录须已存在) |
| 参数 | 说明 |
|---|---|
--app-id | Textin App ID(覆盖环境变量和配置文件) |
--secret-code | Textin Secret Code(覆盖环境变量和配置文件) |
--base-url | API 地址(私有化部署时使用) |
--verbose | 调试模式,打印 HTTP 请求详情 |
API capabilities 默认值
CLI 默认开启以下能力,Agent 无需额外配置:| 能力 | 默认 |
|---|---|
| 标题层级 | 开启 |
| 内嵌对象(图片) | 开启 |
| 图片数据 | 开启 |
| 表格结构(HTML) | 开启 |
| 分页结果 | 开启 |
| 目录树 | 开启 |
| 字符级详情 | 关闭(--include-char-details 开启) |
使用示例
管道组合
批量处理
下载图片
凭证管理
| 优先级 | 方式 | 说明 |
|---|---|---|
| 1 | 命令行参数 | --app-id 和 --secret-code |
| 2 | 环境变量 | XPARSE_APP_ID 和 XPARSE_SECRET_CODE |
| 3 | 配置文件 | ~/.xparse-cli/config.yaml |
支持的文件格式
| 类型 | 格式 |
|---|---|
| 文档 | PDF, DOC, DOCX, TXT, RTF, OFD |
| 图片 | PNG, JPG, JPEG, BMP, TIFF, WebP |
| 表格 | XLS, XLSX, CSV |
| 演示 | PPT, PPTX |
| 网页 | HTML, MHTML |
| 限制项 | 免费 API | 付费 API |
|---|---|---|
| 文件大小 | 10MB | 500MB |
| 页数 | 1000 页/日 | — |
| XLS/XLSX/CSV | — | 每 sheet ≤ 2000 行 × 100 列 |
| TXT | — | ≤ 100KB |
| 图片尺寸 | 20~20000 像素 | 20~20000 像素 |

