5 分钟快速开始
下列步骤可直接复制执行。前 4 步不产生业务写操作;第 5 步为只读列表查询。
1. 安装
npx @kuaimai-cli/cli@latest install
| 成功 | 终端出现安装完成;之后可执行 kuaimai-cli |
| 失败时检查 | 是否已装 Node.js(推荐 20/22 LTS,最低兼容 16);网络能否访问 npm / Gitee / npmmirror;见 安装与升级、故障排查 |
| 下一步 | 确认版本 |
2. 确认版本
kuaimai-cli --version
| 成功 | 打印版本号(如 0.2.27) |
| 失败 | command not found → PATH / 重装;见故障排查 |
| 下一步 | 登录系统授权 |
3. 系统授权登录
向 ERP 管理员申请系统 accessToken 后:
kuaimai-cli auth login system "<accessToken>"
| 成功 | 写入配置;可能自动探测公司/员工信息 |
| 失败 | token 无效/过期 → 重新申请;见 系统授权 |
| 是否写业务数据 | 否,仅本地配置 + 探测用户信息 |
| 下一步 | 自检登录态 |
凭证安全
命令行参数可能进入 Shell 历史与进程列表。用完后可 kuaimai-cli auth logout system。更多见 安全说明。
4. 检查系统授权
kuaimai-cli auth check system --output json
| 成功 | JSON 中 ok: true,含用户/公司信息 |
| 失败 | ok: false,读 error / hint;401/403 见故障排查 |
| 下一步 | 执行第一条只读命令 |
(可选)同时登录开放平台,见 开放平台授权。
5. 第一条命令(只读)
kuaimai-cli erp-item +list \
--body '{"pageNo":1,"pageSize":10}' \
--output json
| 成功 | ok: true,data 中含列表 |
| 失败 | 未登录 / 无权限 / 域名未配置 → auth status、doctor、故障排查 |
| 是否写业务数据 | 否(列表查询) |
PowerShell 续行请用反引号 `,或写成单行。
常用自检
kuaimai-cli doctor --output json
kuaimai-cli auth status --output json