CLI 工具快速上手

最短路径完成 CLI 安装、授权与首次调用。

1. 学习目标与最终效果

本指南带您用最短路径完成：装环境 → 装 CLI → 授权 → 装 Skill → 跑通查询。

完成后，您可以在本机 Agent 中用自然语言查询 CRM 数据。

2. 准备工作

[!IMPORTANT]

• 角色权限：安装与授权需要员工账号；应用配置需要管理员提前完成。
• 系统依赖：已安装 Node.js 18.17 或以上版本。
• 前置配置：管理员已创建企业自建应用，并完成授权模式与 API 权限配置。

3. 分步操作

3.1 检查并安装 Node.js

1. 打开终端，输入 node -v。
2. 若未显示版本号，前往 Node.js 官网下载 LTS 版本并安装。
3. 安装完成后，再次输入 node -v 确认版本不低于 18.17。

[!NOTE]
macOS 用户也可使用 Homebrew 安装，执行 brew install node 即可。

3.2 安装 CLI

1. 打开终端，执行以下命令安装：

npm install -g @share-crm/sharecrm-cli

2. 执行 sharecrm -V 确认安装成功。

[!WARNING]
不要使用 sudo 运行安装与授权命令。以 root 身份运行会导致密钥无法写入个人钥匙串。

3.3 初始化环境

1. 执行 sharecrm config init。
2. 按提示选择语言。

3. 按提示选择环境。

[!NOTE]
本地版本在 1.1.10 以上时，执行命令会自动检查更新，并按提示询问是否升级。

3.4 完成登录授权

1. 建议先在浏览器中登录 CRM 账号。
2. 执行 sharecrm auth login。

3. 在浏览器打开的授权页中，选择要授权的应用。

4. 点击 下一步，确认授权范围后点击 确认授权。

5. 返回终端，确认显示登录授权信息。

3.5 安装 CLI 技能

推荐使用 npx 方式安装：

npx skills add fsxiaoke/sharecrm-cli-skills --skill sharecrm -g -y

如需指定 Agent 安装目标，可追加 --agent 参数，例如 --agent claude-code、--agent codex、--agent cursor。

也可使用脚本方式安装：

curl -fsSL https://raw.githubusercontent.com/fsxiaoke/sharecrm-cli-skills/main/scripts/install.sh | sh

4. 运行与验证

1. 打开您的 Agent 客户端。
2. 输入 /skills 查看已安装技能，确认出现 sharecrm。
3. 用自然语言提问，例如“查询客户张三科技的详情”。
4. 确认 Agent 正确调用命令并返回 CRM 数据。

5. 下一步行动

• 了解应用配置与灰度申请：CLI 工具管理员配置指南。
• 查看全部命令与 Agent 用法：CLI 工具用户操作指南。
• 了解两个工具版本的差异：CLI 工具概述。