用途:通过 /opt/hatch/bin/ghl 命令行工具操作 HighLevel 的 CRM、通信、日程、商务、内容、管理与 AI 等域。面向用户时统一称产品为 HighLevel,不要加“Go”前缀,也不要把内部标识 ghl 展开为显示名。
连接与授权:用 /opt/hatch/bin/ghl status 检查连接;若断开,运行 /opt/hatch/bin/ghl authorize-url 并把返回的 connect_url 分享给用户,由用户自行登录 HighLevel,切勿在对话中索要凭据。
查找操作与子账户:运行 /opt/hatch/bin/ghl list-operations 获取固定操作目录及其细粒度权限方法。CRM/日历读取与对话/消息读取权限相互独立;联系人编辑、笔记/任务、商机、预约、自动化、消息发送与 CRM 删除各有独立控制,消息读取被拒不影响已授权的 CRM/日历读取。用 call-tool --name list_locations --arguments-json '{"query":"<sub-account name>"}' 解析目标子账户,多个匹配时需询问用户,并保留其 ID。用 call-tool --name describe_operation --arguments-json '{"operationId":"<operation ID>"}' 获取精确的 path/query/body 字段与必填输入;search_operations 搜索实时目录;list-tools 返回实时发现工具 schema。
读取或修改数据:使用 /opt/hatch/bin/ghl execute-operation --operation-id <operation ID> --location-id <sub-account ID> --params-json '{"path":{},"query":{},"body":{}}'。联系人创建/更新/upsert 不能带标签,需用 add-tags 或 remove-tags;商机 upsert 不能带关注者管理字段,需用单独的添加/移除关注者操作。只接受分组的 path、query、body 对象,空组可省略。每次逻辑写入/删除需提供新的 --idempotency-key <UUID>,可选 --reason 说明;--dry-run 可预览请求且不需幂等键,但不授权后续写入。
限制与注意:写入和删除默认按域权限请求审批;消息变更(含发送与取消)每次调用都需审批。预约变更可能通知联系人或触发自动化(toNotify 默认 true),活动与工作流注册也可能发起通信,需在请求中说明通知行为。更新或删除前先用读取确认现有记录,不要猜测目标 ID。CLI 不会自动重试变更;提交后失败或结果未确认时,先检查记录或提供方状态再重试,同一逻辑变更保持同一幂等键。除非提供方确认送达,否则只报告为已接受或已排期。财务、发布、消息、访问控制与删除操作视为重大操作:先描述操作、展示确切参数,不得跨子账户推断或复用标识符。尚未进入 list-operations 的未来操作即使读取或 dry-run 也需重新审批。