bitable-upload 1.3.0 → 1.3.2
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.
- package/README.md +28 -133
- package/SKILL.md +8 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,107 +1,65 @@
|
|
|
1
|
-
# 🚀
|
|
2
|
-
|
|
3
|
-
|
|
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">
|
|
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">
|
|
9
|
-
</a>
|
|
10
|
-
<a href="https://github.com/xiaxiamao/xiaxiamao-lark-bitable/blob/main/LICENSE">
|
|
11
|
-
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
|
|
12
|
-
</a>
|
|
13
|
-
</p>
|
|
14
|
-
|
|
15
|
-
<p align="center">
|
|
16
|
-
<b>Xiaxiamao's Lark多维表格通用附件上传工具</b><br>
|
|
17
|
-
支持多种文件类型,自动化批量处理<br>
|
|
18
|
-
<a href="#安装">开始使用</a> • <a href="#功能特性">功能特性</a> • <a href="#使用方法">使用方法</a>
|
|
19
|
-
</p>
|
|
1
|
+
# 🚀 bitable-upload
|
|
2
|
+
|
|
3
|
+
Node.js CLI tool for uploading attachments to Lark Bitable multidimensional tables
|
|
20
4
|
|
|
21
5
|
## 📦 **安装**
|
|
22
6
|
|
|
23
7
|
```bash
|
|
24
8
|
# 全局安装(推荐)
|
|
25
|
-
npm install -g
|
|
9
|
+
npm install -g bitable-upload
|
|
26
10
|
|
|
27
11
|
# 或作为项目依赖
|
|
28
|
-
npm install
|
|
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"
|
|
12
|
+
npm install bitable-upload --save
|
|
42
13
|
```
|
|
43
14
|
|
|
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
15
|
## 🎯 **使用方法**
|
|
54
16
|
|
|
55
17
|
### 1. 交互式模式(推荐)
|
|
56
18
|
```bash
|
|
57
|
-
|
|
58
|
-
# 或
|
|
59
|
-
xiaxiamao-bitable-upload
|
|
19
|
+
bitable-upload
|
|
60
20
|
```
|
|
61
21
|
|
|
62
22
|
### 2. 快速上传模式
|
|
63
23
|
```bash
|
|
64
|
-
|
|
24
|
+
bitable-upload <appToken> <tableId> <recordId> <fieldName> <filePath>
|
|
65
25
|
```
|
|
66
26
|
|
|
67
27
|
### 3. 查看帮助
|
|
68
28
|
```bash
|
|
69
|
-
|
|
29
|
+
bitable-upload --help
|
|
70
30
|
```
|
|
71
31
|
|
|
72
32
|
### 4. 获取版本信息
|
|
73
33
|
```bash
|
|
74
|
-
|
|
34
|
+
bitable-upload --version
|
|
75
35
|
```
|
|
76
36
|
|
|
77
37
|
## ✨ **功能特性**
|
|
78
38
|
|
|
79
|
-
|
|
80
|
-
-
|
|
81
|
-
-
|
|
82
|
-
-
|
|
39
|
+
- **智能发现** - 自动列出多维表格、数据表和附件字段
|
|
40
|
+
- **通用上传** - 支持图片、PDF等任意文件类型
|
|
41
|
+
- **批量处理** - 支持多文件批量上传
|
|
42
|
+
- **错误重试** - 自动重试失败的任务
|
|
43
|
+
- **Token管理** - 自动处理Token过期和刷新
|
|
83
44
|
|
|
84
|
-
|
|
85
|
-
- **多文件类型** - 支持图片、PDF、文档等任意文件
|
|
86
|
-
- **自动类型检测** - 根据文件扩展名自动选择上传类型
|
|
87
|
-
- **大文件支持** - 支持分片上传(大文件自动处理)
|
|
45
|
+
## 🔧 **配置**
|
|
88
46
|
|
|
89
|
-
###
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
47
|
+
### 环境变量配置
|
|
48
|
+
```bash
|
|
49
|
+
# Lark应用凭证(必需)
|
|
50
|
+
export LARK_APP_ID="cli_your_app_id"
|
|
51
|
+
export LARK_APP_SECRET="your_app_secret"
|
|
93
52
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
- **日志记录** - 详细的操作日志和错误追踪
|
|
53
|
+
# 可选:设置默认参数
|
|
54
|
+
export LARK_DEFAULT_APP_TOKEN="your_default_app_token"
|
|
55
|
+
export LARK_DEFAULT_TABLE_ID="your_default_table_id"
|
|
56
|
+
```
|
|
99
57
|
|
|
100
58
|
## 🎯 **使用示例**
|
|
101
59
|
|
|
102
60
|
### 交互式上传流程
|
|
103
61
|
```
|
|
104
|
-
$
|
|
62
|
+
$ bitable-upload
|
|
105
63
|
|
|
106
64
|
🚀 开始多维表格附件上传流程
|
|
107
65
|
|
|
@@ -152,39 +110,13 @@ $ xb-upload
|
|
|
152
110
|
|
|
153
111
|
### 快速上传
|
|
154
112
|
```bash
|
|
155
|
-
|
|
113
|
+
bitable-upload app_a1b2c3d4e5f6g7h8 table_1a2b3c4d5e6f7g8h rec_1a2b3c4d5e "设计稿" /tmp/design.png
|
|
156
114
|
```
|
|
157
115
|
|
|
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
116
|
## 📋 **API使用**
|
|
185
117
|
|
|
186
118
|
```javascript
|
|
187
|
-
const FeishuBitableAttachmentUploader = require('
|
|
119
|
+
const FeishuBitableAttachmentUploader = require('bitable-upload');
|
|
188
120
|
|
|
189
121
|
// 创建上传器
|
|
190
122
|
const uploader = new FeishuBitableAttachmentUploader(
|
|
@@ -206,45 +138,8 @@ await uploader.quickUpload({
|
|
|
206
138
|
await uploader.interactiveUpload();
|
|
207
139
|
```
|
|
208
140
|
|
|
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
141
|
## 📄 **许可证**
|
|
247
142
|
MIT License
|
|
248
143
|
|
|
249
144
|
## 🤝 **贡献**
|
|
250
|
-
欢迎提交Issue和Pull Request
|
|
145
|
+
欢迎提交Issue和Pull Request
|
package/SKILL.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
# 🚀
|
|
1
|
+
# 🚀 bitable-upload Skill
|
|
2
2
|
|
|
3
3
|
## 🎯 **技能概述**
|
|
4
|
-
|
|
4
|
+
bitable-upload 是Node.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
|
|
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
|
-
|
|
50
|
+
bitable-upload
|
|
51
51
|
|
|
52
52
|
# 快速上传模式
|
|
53
|
-
|
|
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.
|
|
272
|
-
**最后更新**: 2026年3月17日
|
|
264
|
+
**技能版本**: v1.3.0
|
|
265
|
+
**最后更新**: 2026年3月17日
|