bitable-upload 1.3.0 → 1.3.1

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 (3) hide show
  1. package/README.md +8 -239
  2. package/SKILL.md +8 -15
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,250 +1,19 @@
1
- # 🚀 xiaxiamao-lark-bitable
1
+ # 🚀 bitable-upload
2
2
 
3
3
  <p align="center">
4
- <a href="https://github.com/xiaxiamao/xiaxiamao-lark-bitable/releases">
5
- <img src="https://img.shields.io/github/v/release/xiaxiamao/xiaxiamao-lark-bitable" alt="Release">
4
+ <a href="https://github.com/xiaxiamao2026/xiaxiamao-lark-bitable/releases">
5
+ <img src="https://img.shields.io/github/v/release/xiaxiamao2026/xiaxiamao-lark-bitable" alt="Release">
6
6
  </a>
7
- <a href="https://www.npmjs.com/package/xiaxiamao-lark-bitable">
8
- <img src="https://img.shields.io/npm/v/xiaxiamao-lark-bitable" alt="npm">
7
+ <a href="https://www.npmjs.com/package/bitable-upload">
8
+ <img src="https://img.shields.io/npm/v/bitable-upload" alt="npm">
9
9
  </a>
10
- <a href="https://github.com/xiaxiamao/xiaxiamao-lark-bitable/blob/main/LICENSE">
10
+ <a href="https://github.com/xiaxiamao2026/xiaxiamao-lark-bitable/blob/main/LICENSE">
11
11
  <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
12
12
  </a>
13
13
  </p>
14
14
 
15
15
  <p align="center">
16
- <b>Xiaxiamao's Lark多维表格通用附件上传工具</b><br>
17
- 支持多种文件类型,自动化批量处理<br>
16
+ <b>Node.js CLI工具 - 上传附件到Lark多维表格</b><br>
17
+ 支持图片和PDF文件,命令行调用<br>
18
18
  <a href="#安装">开始使用</a> • <a href="#功能特性">功能特性</a> • <a href="#使用方法">使用方法</a>
19
19
  </p>
20
-
21
- ## 📦 **安装**
22
-
23
- ```bash
24
- # 全局安装(推荐)
25
- npm install -g xiaxiamao-lark-bitable
26
-
27
- # 或作为项目依赖
28
- npm install xiaxiamao-lark-bitable --save
29
- ```
30
-
31
- ## 🔧 **配置**
32
-
33
- ### 环境变量配置
34
- ```bash
35
- # Lark应用凭证(必需)
36
- export LARK_APP_ID="cli_your_app_id"
37
- export LARK_APP_SECRET="your_app_secret"
38
-
39
- # 可选:设置默认参数
40
- export LARK_DEFAULT_APP_TOKEN="your_default_app_token"
41
- export LARK_DEFAULT_TABLE_ID="your_default_table_id"
42
- ```
43
-
44
- ### 获取应用凭证
45
- 1. 访问 [Lark开放平台](https://open.larksuite.com/)
46
- 2. 创建或选择应用
47
- 3. 在"凭证与基础信息"中获取App ID和App Secret
48
- 4. 确保开启以下权限:
49
- - `bitable:app` - 多维表格访问
50
- - `docs:document.media:upload` - 素材上传
51
- - `drive:drive` - 文件管理
52
-
53
- ## 🎯 **使用方法**
54
-
55
- ### 1. 交互式模式(推荐)
56
- ```bash
57
- xb-upload
58
- # 或
59
- xiaxiamao-bitable-upload
60
- ```
61
-
62
- ### 2. 快速上传模式
63
- ```bash
64
- xb-upload <appToken> <tableId> <recordId> <fieldName> <filePath>
65
- ```
66
-
67
- ### 3. 查看帮助
68
- ```bash
69
- xb-upload --help
70
- ```
71
-
72
- ### 4. 获取版本信息
73
- ```bash
74
- xb-upload --version
75
- ```
76
-
77
- ## ✨ **功能特性**
78
-
79
- ### 🔍 **智能发现**
80
- - **自动发现** - 列出所有多维表格应用
81
- - **字段识别** - 智能识别附件字段(支持多附件字段)
82
- - **记录定位** - 准确找到目标记录(支持记录ID和序号)
83
-
84
- ### 📤 **通用上传**
85
- - **多文件类型** - 支持图片、PDF、文档等任意文件
86
- - **自动类型检测** - 根据文件扩展名自动选择上传类型
87
- - **大文件支持** - 支持分片上传(大文件自动处理)
88
-
89
- ### 🔄 **批量处理**
90
- - **批量上传** - 支持多文件批量上传
91
- - **记录批量更新** - 支持多记录同时更新
92
- - **进度显示** - 实时显示上传进度
93
-
94
- ### 🛡️ **企业级特性**
95
- - **错误重试** - 自动重试失败的任务
96
- - **Token管理** - 自动处理Token过期和刷新
97
- - **权限验证** - 完整的权限检查和错误提示
98
- - **日志记录** - 详细的操作日志和错误追踪
99
-
100
- ## 🎯 **使用示例**
101
-
102
- ### 交互式上传流程
103
- ```
104
- $ xb-upload
105
-
106
- 🚀 开始多维表格附件上传流程
107
-
108
- 📋 正在获取多维表格列表...
109
- 📋 可用的多维表格:
110
- 1. 项目管理表 (app_a1b2c3d4e5f6g7h8)
111
- 2. 资产登记表 (app_i9j0k1l2m3n4o5p6)
112
- 3. 产品资料库 (app_q7r8s9t0u1v2w3x4)
113
-
114
- 请选择表格编号 (1-3): 1
115
- ✅ 已选择表格: 项目管理表
116
-
117
- 🗂️ 正在获取数据表列表...
118
- 🗂️ 数据表列表:
119
- 1. 项目附件 (table_1a2b3c4d5e6f7g8h)
120
- 2. 团队资料 (table_9i0j1k2l3m4n5o6p)
121
-
122
- 请选择数据表编号 (1-2): 1
123
- ✅ 已选择数据表: 项目附件
124
-
125
- 🔍 正在获取字段列表...
126
- 📎 附件字段列表:
127
- 1. 设计稿 (field_design)
128
- 2. 需求文档 (field_requirements)
129
-
130
- 请选择附件字段编号 (1-2): 1
131
- ✅ 已选择附件字段: 设计稿
132
-
133
- 📝 正在获取记录列表...
134
- 📝 记录列表 (前20条):
135
- 1. 移动端UI设计 (rec_1a2b3c4d5e)
136
- 2. 后台管理系统 (rec_6f7g8h9i0j)
137
- 3. 数据可视化大屏 (rec_k1l2m3n4o5)
138
-
139
- 请选择记录编号 (1-20) 或输入记录ID: 1
140
- ✅ 已选择记录: rec_1a2b3c4d5e
141
-
142
- 📁 请输入要上传的图片文件路径: /tmp/design_mockup.png
143
- 📤 正在上传图片: /tmp/design_mockup.png...
144
- ✅ 文件上传成功: file_x1y2z3a4b5c6d7e8f9
145
-
146
- 🔄 正在更新记录附件字段...
147
- 🎉 附件上传完成!
148
- 📎 记录ID: rec_1a2b3c4d5e
149
- 📄 字段: 设计稿
150
- 🖼️ 附件: file_x1y2z3a4b5c6d7e8f9
151
- ```
152
-
153
- ### 快速上传
154
- ```bash
155
- xb-upload app_a1b2c3d4e5f6g7h8 table_1a2b3c4d5e6f7g8h rec_1a2b3c4d5e "设计稿" /tmp/design.png
156
- ```
157
-
158
- ## 🔑 **获取Token的方法**
159
-
160
- ### 1. 获取App ID和App Secret
161
- - 进入飞书开放平台
162
- - 创建或选择应用
163
- - 在"凭证与基础信息"中查看
164
-
165
- ### 2. 获取多维表格Token
166
- - 打开多维表格
167
- - 从URL中获取: `https://my.feishu.cn/base/{app_token}`
168
- - 或使用API列出所有表格
169
-
170
- ### 3. 获取数据表ID
171
- - 在表格内点击"分享" → "复制链接"
172
- - 或从URL中获取: `.../base/{app_token}?table={table_id}`
173
-
174
- ### 4. 获取记录ID
175
- - 在表格中右键点击记录
176
- - 选择"复制记录ID"
177
- - 或从API获取记录列表
178
-
179
- ### 5. 获取字段名称
180
- - 查看表格字段设置
181
- - 或使用API获取字段列表
182
- - 附件字段类型为17
183
-
184
- ## 📋 **API使用**
185
-
186
- ```javascript
187
- const FeishuBitableAttachmentUploader = require('feishu-bitable-attachment-upload');
188
-
189
- // 创建上传器
190
- const uploader = new FeishuBitableAttachmentUploader(
191
- 'your_app_id',
192
- 'your_app_secret'
193
- );
194
-
195
- // 快速上传
196
- await uploader.quickUpload({
197
- appToken: 'your_app_token',
198
- tableId: 'your_table_id',
199
- recordId: 'your_record_id',
200
- fieldName: '附件字段名',
201
- filePath: '/path/to/image.png',
202
- customName: 'custom_name.png' // 可选
203
- });
204
-
205
- // 交互式上传
206
- await uploader.interactiveUpload();
207
- ```
208
-
209
- ## 🛡️ **权限要求**
210
-
211
- 在飞书应用中需要开启以下权限:
212
- - `bitable:app` - 多维表格访问
213
- - `docs:document.media:upload` - 素材上传
214
- - `drive:drive` - 文件管理
215
-
216
- ## 💡 **最佳实践**
217
-
218
- 1. **先测试权限**: 确保应用有足够权限
219
- 2. **小文件测试**: 先用小文件测试上传流程
220
- 3. **备份数据**: 上传前备份重要数据
221
- 4. **字段命名**: 使用清晰的字段名称
222
- 5. **记录管理**: 定期清理不需要的附件
223
-
224
- ## 🔧 **调试技巧**
225
-
226
- ```bash
227
- # 调试模式查看所有表格
228
- feishu-bitable-upload --debug
229
-
230
- # 查看详细错误信息
231
- DEBUG=* feishu-bitable-upload
232
-
233
- # 测试特定表格
234
- feishu-bitable-upload app_token table_id record_id field_name /path/to/test.png
235
- ```
236
-
237
- ## 📞 **故障排除**
238
-
239
- | 错误 | 原因 | 解决方案 |
240
- |------|------|----------|
241
- | 403 | 权限不足 | 检查应用权限 |
242
- | 404 | 资源不存在 | 检查Token和ID |
243
- | 1062009 | 文件大小不匹配 | 检查文件大小参数 |
244
- | TextFieldConvFail | 字段类型不匹配 | 确认是附件字段 |
245
-
246
- ## 📄 **许可证**
247
- MIT License
248
-
249
- ## 🤝 **贡献**
250
- 欢迎提交Issue和Pull Request
package/SKILL.md CHANGED
@@ -1,7 +1,7 @@
1
- # 🚀 xiaxiamao-lark-bitable Skill
1
+ # 🚀 bitable-upload Skill
2
2
 
3
3
  ## 🎯 **技能概述**
4
- xiaxiamao-lark-bitableXiaxiamao开发的Lark多维表格通用附件上传工具,支持任意多维表格的附件字段上传操作。
4
+ bitable-uploadNode.js CLI工具,用于上传附件到Lark多维表格,支持任意多维表格的附件字段上传操作。
5
5
 
6
6
  ## 📋 **功能特性**
7
7
 
@@ -30,7 +30,7 @@ xiaxiamao-lark-bitable 是Xiaxiamao开发的Lark多维表格通用附件上传
30
30
 
31
31
  ### 📦 **安装**
32
32
  ```bash
33
- npm install -g xiaxiamao-lark-bitable
33
+ npm install -g bitable-upload
34
34
  ```
35
35
 
36
36
  ### 🔧 **配置环境变量**
@@ -47,20 +47,13 @@ export LARK_DEFAULT_TABLE_ID="your_default_table_id"
47
47
  ### 🎯 **使用方式**
48
48
  ```bash
49
49
  # 交互式模式
50
- xb-upload
50
+ bitable-upload
51
51
 
52
52
  # 快速上传模式
53
- xb-upload <appToken> <tableId> <recordId> <fieldName> <filePath>
53
+ bitable-upload <appToken> <tableId> <recordId> <fieldName> <filePath>
54
54
  ```
55
55
 
56
- ## 🚀 **快速开始**
57
-
58
- ### 📝 **安装使用**
59
- ```bash
60
- # 技能已集成到系统中,直接使用相关命令即可
61
- ```
62
-
63
- ### 🎯 **基本使用流程**
56
+ ## 🎯 **基本使用流程**
64
57
  1. 获取多维表格列表
65
58
  2. 选择目标表格和记录
66
59
  3. 识别附件字段
@@ -268,5 +261,5 @@ console.log("✅ 附件上传成功!");
268
261
 
269
262
  ---
270
263
 
271
- **技能版本**: v1.0.0
272
- **最后更新**: 2026年3月17日
264
+ **技能版本**: v1.3.0
265
+ **最后更新**: 2026年3月17日
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bitable-upload",
3
- "version": "1.3.0",
3
+ "version": "1.3.1",
4
4
  "description": "Node.js CLI tool for uploading attachments to Lark Bitable multidimensional tables",
5
5
  "main": "index.js",
6
6
  "bin": {