@windaka-erp/erp-cli 0.1.0 → 0.2.0
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 +51 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,26 +1,64 @@
|
|
|
1
1
|
# @windaka-erp/erp-cli
|
|
2
2
|
|
|
3
|
-
物达通（WindaKa）物业管理 ERP
|
|
3
|
+
物达通（WindaKa）物业管理 ERP 系统命令行工具，为人类和 AI Agent 设计。
|
|
4
4
|
|
|
5
5
|
## 安装
|
|
6
6
|
|
|
7
|
+
以下两种方式**任选其一**：
|
|
8
|
+
|
|
9
|
+
**方式一 — 从 npm 安装（推荐）：**
|
|
10
|
+
|
|
7
11
|
```bash
|
|
12
|
+
# 安装 CLI
|
|
8
13
|
npm install -g @windaka-erp/erp-cli
|
|
14
|
+
|
|
15
|
+
# 安装 Skills（必需，让 AI Agent 知道如何使用 CLI）
|
|
16
|
+
npx skills add windaka-erp/erp-cli -y -g
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
**方式二 — 从源码安装：**
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
git clone https://github.com/windaka-erp/erp-cli.git
|
|
23
|
+
cd erp-cli
|
|
24
|
+
go build -o erp-cli .
|
|
25
|
+
|
|
26
|
+
# 安装 Skills（必需）
|
|
27
|
+
npx skills add windaka-erp/erp-cli -y -g
|
|
9
28
|
```
|
|
10
29
|
|
|
11
30
|
## 快速开始
|
|
12
31
|
|
|
32
|
+
### 人类用户
|
|
33
|
+
|
|
13
34
|
```bash
|
|
14
|
-
# 初始化配置
|
|
35
|
+
# 1. 初始化配置
|
|
15
36
|
erp-cli --as me config init
|
|
16
37
|
|
|
17
|
-
# 登录
|
|
38
|
+
# 2. 登录
|
|
18
39
|
erp-cli --as me auth login
|
|
19
40
|
|
|
20
|
-
#
|
|
21
|
-
erp-cli --as me
|
|
41
|
+
# 3. 开始使用
|
|
42
|
+
erp-cli --as me workorder +list
|
|
22
43
|
```
|
|
23
44
|
|
|
45
|
+
### AI Agent
|
|
46
|
+
|
|
47
|
+
> 以下步骤面向 AI Agent。详细步骤见 [INSTALL.md](./INSTALL.md)。
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
# 安装 CLI
|
|
51
|
+
npm install -g @windaka-erp/erp-cli
|
|
52
|
+
|
|
53
|
+
# 安装 Skills（必需）
|
|
54
|
+
npx skills add windaka-erp/erp-cli -y -g
|
|
55
|
+
|
|
56
|
+
# 验证
|
|
57
|
+
erp-cli --help
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
安装完成即可使用。知识库检索无需登录；需要登录的操作（如工单查询）会在调用时自动引导。
|
|
61
|
+
|
|
24
62
|
## 命令
|
|
25
63
|
|
|
26
64
|
```
|
|
@@ -37,6 +75,14 @@ erp-cli --as <id> workorder +list/+create # 工单操作
|
|
|
37
75
|
- `--as <id>` — 用户标识（必填），企业微信用 Sender ID，本地用任意稳定标识（如 `me`）
|
|
38
76
|
- `--dry-run` — 预览请求内容，不实际执行
|
|
39
77
|
|
|
78
|
+
## Agent Skills
|
|
79
|
+
|
|
80
|
+
| Skill | 说明 |
|
|
81
|
+
|-------|------|
|
|
82
|
+
| `erp-cli` | ERP 系统总入口：知识库检索、工单管理、认证配置、意图路由 |
|
|
83
|
+
|
|
84
|
+
安装 Skills 后，AI Agent 会自动读取 [skills/SKILL.md](./skills/SKILL.md) 获取完整的使用指南。
|
|
85
|
+
|
|
40
86
|
## 要求
|
|
41
87
|
|
|
42
88
|
- Node.js >= 14.0.0
|