xparse-cli 2.3.1-beta.1 → 2.3.1-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +61 -16
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -37,7 +37,7 @@ npm install --global xparse-cli@beta
37
37
  为了获得可复现的测试环境，应安装精确版本：
38
38
 
39
39
  ```bash
40
- npm install --global xparse-cli@2.3.1-beta.1
40
+ npm install --global xparse-cli@2.3.0-beta.5
41
41
  ```
42
42
 
43
43
  ### 升级
@@ -51,6 +51,58 @@ beta、精确版本以及国内镜像同样通过 `npm install --global` 管理
51
51
  WorkBuddy 集成、国内/海外 Connector 区别、beta 命名规则及完整发版步骤见
52
52
  [WorkBuddy Connector 概念与发版流程](docs/workbuddy_connector_release.md)。
53
53
 
54
+ ## 开发与发布 Make 命令
55
+
56
+ 仓库根目录的 `Makefile` 统一管理 WorkBuddy Connector 组包和 npm 发布。
57
+ `REGION` 未设置或为空时默认生成国内包。
58
+
59
+ 生成国内、海外或双区域的 Connector 正式审核包：
60
+
61
+ ```bash
62
+ make connector-review
63
+ make connector-review REGION=global
64
+ make connector-review-all
65
+ ```
66
+
67
+ 生成指定环境的 Connector 测试安装包。`VERSION` 为需要测试的精确 CLI 版本，
68
+ `ENVIRONMENT` 支持 `test`、`pre` 和 `prod`：
69
+
70
+ ```bash
71
+ make connector-test VERSION=2.3.1-beta.1 ENVIRONMENT=test
72
+ ```
73
+
74
+ 如需使用其他通用 xParse Skill 目录，可显式传入：
75
+
76
+ ```bash
77
+ make connector-test \
78
+ VERSION=2.3.1-beta.1 \
79
+ ENVIRONMENT=test \
80
+ SKILL_DIR=/path/to/xparse-skills/skills/xparse-parse
81
+ ```
82
+
83
+ 同步 npm 持久版本。该命令会更新主包版本、六个平台依赖版本、npm tag 和
84
+ `release-lock.json` 的基础版本：
85
+
86
+ ```bash
87
+ make set-version VERSION=2.3.1-beta.1
88
+ ```
89
+
90
+ 执行七个 npm 包的完整打包与发布 dry-run，不会上传包：
91
+
92
+ ```bash
93
+ make npm-publish-dry-run VERSION=2.3.1-beta.1
94
+ ```
95
+
96
+ 正式发布七个 npm 包必须同时指定精确版本和确认开关：
97
+
98
+ ```bash
99
+ make npm-publish VERSION=2.3.1-beta.1 CONFIRM_PUBLISH=1
100
+ ```
101
+
102
+ `npm-publish` 和 `npm-publish-dry-run` 都会先同步版本，并校验命令版本、源码
103
+ manifest、staging 目录和七个待发布包完全一致。stable 版本发布到 `latest`，
104
+ `-beta.*` 版本发布到 `beta`。
105
+
54
106
  ## 快速开始
55
107
 
56
108
  ### 1. 零配置解析（自动使用免费额度）
@@ -94,20 +146,7 @@ export XPARSE_SECRET_CODE=your_secret_code
94
146
  xparse-cli parse report.pdf --api paid
95
147
  ```
96
148
 
97
- ### 3. 上传单个文件供 Remote MCP 使用
98
-
99
- Remote MCP 不能直接读取本地路径。先上传一个本地文件取得 File Asset `file_id`，
100
- 再将该 ID 交给 Remote MCP 的 `parse_document`。上传命令不会创建或运行 Task。
101
-
102
- ```bash
103
- xparse-cli file upload report.pdf --auth-method oauth
104
- xparse-cli file upload secret.pdf --auth-method oauth --password open-password
105
- ```
106
-
107
- 命令只接受一个文件，stdout 返回一份 File Asset JSON。上传和 Remote MCP 必须授权为
108
- 同一个 TextIn 账号。
109
-
110
- ### 4. 多文件 Task Runtime（Agent 推荐）
149
+ ### 3. 多文件 Task Runtime（Agent 推荐）
111
150
 
112
151
  Task Runtime 把上传、执行状态和结果交给服务端持久化。`task run` 默认在提交 Run
113
152
  成功后立即返回 `operation_id`、`task_id` 和 `run_id`；Agent 后续锁定该 Run 查看进度，完成后再按需读取或导出结果，不需要把全部结果放进上下文。WorkBuddy 下 stderr 输出 `xparse_event.v1` JSONL：服务端接受 Run 后立即输出 `run_accepted`，后续状态变化输出 `run_status`；stdout 始终只输出一份最终提交 JSON。
@@ -116,10 +155,16 @@ Task Runtime 把上传、执行状态和结果交给服务端持久化。`task r
116
155
  xparse-cli task run --files 'contracts/*.pdf'
117
156
  xparse-cli task status <task-id> --run-id <run-id>
118
157
  xparse-cli task export <task-id> --run-id <run-id> --output ./task-output
158
+ xparse-cli task export <task-id> --run-id <run-id> --view json --output ./task-json
119
159
  xparse-cli task read <task-id> contract-a.pdf --run-id <run-id>
120
160
  xparse-cli task debug <task-id> --run-id <run-id>
121
161
  ```
122
162
 
163
+ `task export` 默认导出 Markdown；需要消费完整 xParse 结构化结果时显式使用
164
+ `--view json`。两种视图都会生成 `task-manifest.json`，其中包含
165
+ `total_count`、`completed_count`、`failed_count`、`exported_count` 以及每个文件的
166
+ 状态、输出文件名和失败恢复信息，调用方不得把部分成功静默当作全量完成。
167
+
123
168
  需要在同一个 Task 下创建新 Run 时，显式选择重跑范围：
124
169
 
125
170
  ```bash
@@ -255,7 +300,7 @@ xparse-cli --profile easyclaw parse report.pdf --api paid --auth-method oauth
255
300
  | `xparse-cli task run` | 上传并执行多文件持久化 Task |
256
301
  | `xparse-cli task rerun` | 在现有 Task 下按 all/new-files/selected-files 创建新 Run |
257
302
  | `xparse-cli task status` | 查询 Task 和最新 Run 状态 |
258
- | `xparse-cli task export` | 批量导出成功结果和 manifest |
303
+ | `xparse-cli task export` | 按 Markdown/JSON 视图批量导出成功结果和带汇总计数的 manifest |
259
304
  | `xparse-cli task read` | 读取单个文件结果 |
260
305
  | `xparse-cli task debug` | 查看逐文件错误与恢复证据 |
261
306
  | `xparse-cli task continue` | 补充逐文件密码并选择性续跑 |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "xparse-cli",
3
- "version": "2.3.1-beta.1",
3
+ "version": "2.3.1-beta.3",
4
4
  "description": "TextIn xParse command-line client for document parsing",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -19,12 +19,12 @@
19
19
  "node": ">=18"
20
20
  },
21
21
  "optionalDependencies": {
22
- "xparse-cli-darwin-amd64": "2.3.1-beta.1",
23
- "xparse-cli-darwin-arm64": "2.3.1-beta.1",
24
- "xparse-cli-linux-amd64": "2.3.1-beta.1",
25
- "xparse-cli-linux-arm64": "2.3.1-beta.1",
26
- "xparse-cli-windows-amd64": "2.3.1-beta.1",
27
- "xparse-cli-windows-arm64": "2.3.1-beta.1"
22
+ "xparse-cli-darwin-amd64": "2.3.1-beta.3",
23
+ "xparse-cli-darwin-arm64": "2.3.1-beta.3",
24
+ "xparse-cli-linux-amd64": "2.3.1-beta.3",
25
+ "xparse-cli-linux-arm64": "2.3.1-beta.3",
26
+ "xparse-cli-windows-amd64": "2.3.1-beta.3",
27
+ "xparse-cli-windows-arm64": "2.3.1-beta.3"
28
28
  },
29
29
  "publishConfig": {
30
30
  "access": "public",