纷享销客CLI简介
CLI（Command Line Interface，命令行接口）是一种通过终端输入文本指令来操作软件的方式。它不依赖图形界面，开发者或运维人员只需在终端敲入命令，就能完成过去需要反复点击鼠标才能完成的操作。
纷享销客 CLI 是纷享销客面向企业用户提供的官方命令行工具。它将纷享 CRM 的核心能力封装为标准化的终端命令，让你可以在命令行环境中完成客户查询、数据导出、流程触发、自动化任务编排等一系列 CRM 操作。
1、前置条件
- Node.js:
>=18.17 ,使用命令：node -v 检查本机是否已经安装好nodejs，版本是否>=18.17,如果未显示版本则说明没有安装过node.js需要先安装成功 - 安装Nodejs
1.1、windows 系统下安装Node.js
第一步：下载安装包 访问 Node.js 官方网站：https://nodejs.org/。 你会看到两个版本： LTS (Long-Term Support)：长期支持版，推荐绝大多数用户安装，因为它更稳定、可靠。 Current：最新尝鲜版，包含最新的功能，但可能存在一些不稳定的因素。 点击 LTS 版本对应的 Windows 安装程序（文件后缀为 .msi）进行下载。
第二步：运行安装 找到下载好的 .msi 文件，双击运行，启动安装向导。 在安装过程中，有几个关键选项需要注意： 接受许可协议：勾选同意，点击“下一步”。 安装路径：你可以选择默认路径（C:\Program Files\nodejs\），也可以点击“Change...”自定义路径。 自定义组件：保持默认设置即可。但请务必确保 Add to PATH 这个选项是勾选状态，它能让你在命令行中直接使用 node 和 npm 命令。 自动安装必要工具：这一步是可选的。如果弹出提示框询问是否安装“Tools for Native Modules”，通常可以直接跳过，等到未来确实需要编译原生模块时再安装也不迟。
第三步：验证安装 Win + R 打开“运行”对话框，输入 cmd 并回车，打开命令提示符。 依次输入以下命令并回车. 检查是否安装成功：node -v
第二步：运行安装 找到下载好的 .msi 文件，双击运行，启动安装向导。 在安装过程中，有几个关键选项需要注意： 接受许可协议：勾选同意，点击“下一步”。 安装路径：你可以选择默认路径（C:\Program Files\nodejs\），也可以点击“Change...”自定义路径。 自定义组件：保持默认设置即可。但请务必确保 Add to PATH 这个选项是勾选状态，它能让你在命令行中直接使用 node 和 npm 命令。 自动安装必要工具：这一步是可选的。如果弹出提示框询问是否安装“Tools for Native Modules”，通常可以直接跳过，等到未来确实需要编译原生模块时再安装也不迟。
第三步：验证安装 Win + R 打开“运行”对话框，输入 cmd 并回车，打开命令提示符。 依次输入以下命令并回车. 检查是否安装成功：node -v
1.2、Linux 系统下安装Node.js
# 安装 Node.js 24.x
curl -fsSL https://deb.nodesource.com/setup_24.x | sudo -E bash -
sudo apt install -y nodejs
# 验证版本（必须 ≥22）
node -v1.3、MacOS系统下安装Node.js
方式一：官网下载安装程序（适合新手） 访问 Node.js 官方网站，下载 LTS（长期支持版） 的 macOS 安装程序（.pkg 文件）。 双击 .pkg 文件，按照安装向导的提示完成安装。 安装完成后，打开“终端” (Terminal)。 输入 node -v 和 npm -v 验证是否成功。
方式二：使用 Homebrew 安装（适合开发者） 如果尚未安装 Homebrew，请在“终端”中运行以下命令：
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" Homebrew 安装完成后，执行以下命令安装 Node.js： bash brew install node Homebrew 会将 Node.js 自动链接到系统路径。 完成后在终端输入 node -v 验证。
方式二：使用 Homebrew 安装（适合开发者） 如果尚未安装 Homebrew，请在“终端”中运行以下命令：
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" Homebrew 安装完成后，执行以下命令安装 Node.js： bash brew install node Homebrew 会将 Node.js 自动链接到系统路径。 完成后在终端输入 node -v 验证。
2、CLI 安装
打开系统的终端命令窗口，输入如下命令：
# 使用npm安装sharcrm CLI：
npm install -g sharecrm@1.1.6
# 检查是是否安装成功：
sharecrm -V
3、CLI应用创建
角色：企业拥有【应用列表】权限的管理员
- 登录纷享CRM后台，进入“应用列表”管理页面
- 点击创建“企业自建应用”按钮，跳转地址：https://www.fxiaoke.com
- 输入应用名称，完成应用创建后，重新进入应用编辑页面
- 开启自建应用的“开发者模式”并且选择授权模式“Device Flow”
可精确限制权限
4、CLI基本命令
成功安装好sharecrm程序后，打开系统的终端命令窗口，输入 sharecrm --help 查看可用的命令
4.1、登录授权命令：sharecrm auth --help
在首次执行业务命令之前必需先完成登录授权，使用 sharecrm auth login 进行授权登录
在浏览器中打开授权链接：选择要授权的应用并点击下一步，注意如果授权之前未登录纷享CRM系统则会先跳转到登录页面，成功登录CRM员工账号后会自动跳转回到授权页面。
确认应用授权范围并点击“确认授权”，完成授权操作
授权成功后的结果：
终端命令行窗口会自动显示登录授权后的信息：
4.2、查看登录状态 sharecrm auth status
4.3、退出登录状态 sharecrm auth logout
4.4、远程命令执行 sharecrm -h ,查看所有一级命令
approval 查询审批任务并执行审批决策，例如批准、拒绝或取消
bi 查询、分析和导出业务智能数据集、指标和分析视图
bpm 启动、运行、查询和取消BPM流程实例及相关工作流任务
channel 处理跨渠道会话路由、消息传递和转移操作
conversation 查询、发送和传输群组聊天或对话会话，用于协作通信
data CRM通用对象数据操作，包括查询，新建，编辑，根据SQL查询等
describe CRM对象描述的基本操作，包括查询对象ApiName，查询对象描述等
enterprise 查找公司资料、行业情报、法律风险、上市公司数据和招标信息
file 上传、转换、导出并查询文件、附件和云盘资源
flow AI 工作流编排工具，串联大模型、插件与数据能力，快速搭建自动化智能任务流程
knowledge 检索文档，搜索知识源，并根据有依据的上下文回答问题
location 按地理 / 行政维度划分组织、统一编码、绑定业务、支撑跨区域管控与统计
mail 发送和查询电子邮件消息、邮件任务和交付记录
marketing 生成SDR脚本、营销内容、受众运营和增长洞察工作流程
notice 发送和查询产品内通知、警报和消息传递任务
object 查询和修改结构化业务数据、记录和基于架构的数据实体
sales 管理客户、潜在客户、联系人、销售机会、活动和销售报告的CRM生命周期
service 处理工单、故障诊断、备件查询、服务分析和服务记录操作
solution 为解决方案设计和业务规划生成建议、摘要和分析结果
stage 跟踪跨工作流程、手册和生命周期步骤的阶段进度
tag 创建、更新、删除和查询用于标记和分类记录的标签
usergroup 管理用户组、成员关系和组级配置查询
utility 在各个领域中执行可重用的实用函数、连接器和共享辅助功能
visit 支持现场拜访、检查点、路线规划、门店订单处理和销售分析
work 从创建到完成管理日程、任务、待办事项和工作项
workflow 开始、运行和查询轻量级业务流程和执行流水线
4.5、使用--help 参数查看命令的使用帮助信息
5、CLI技能安装
5.1 使用npx skills add 命令安装（推荐）
# 全局安装 skill，注：覆盖安装即为更新
npx skills add emengs/sharecrm-cli-skills --skill sharecrm -g -y
# 如果你要指定 agent 安装目标，可以使用：
npx skills add emengs/sharecrm-cli-skills --skill sharecrm --agent claude-code -g -y
npx skills add emengs/sharecrm-cli-skills --skill sharecrm --agent codex -g -y
npx skills add emengs/sharecrm-cli-skills --skill sharecrm --agent gemini-cli -g -y
npx skills add emengs/sharecrm-cli-skills --skill sharecrm --agent openclaw -g -y
npx skills add emengs/sharecrm-cli-skills --skill sharecrm --agent cursor -g -y5.2、使用脚本安装
# macOS / Linux：
curl -fsSL https://raw.githubusercontent.com/emengs/sharecrm-cli-skills/main/scripts/install.sh | sh
# Windows PowerShell：
irm https://raw.githubusercontent.com/emengs/sharecrm-cli-skills/main/scripts/install.ps1 | iex
6、在 Agent中使用CLI
6.1、在Claude Code中使用sharecrm CLI能力
使用/skills命令查看Claude中已经安装的skills，是否出现了sharecrm技能？
示例：查询客户对象数据资料
经过多轮命令的执行，最终成功查询到了客户数据：
自动找到客户详情命令并正确提交命令参数，成功把客户详情信息查询到了。
