CLI 使用帮助
HAP CLI 把 HAP 的后端能力封装到命令行里,覆盖三类场景:
协作沟通 — 查通讯录/部门、收发单聊和群聊消息、发动态、管日程
应用数据 — 读写工作表记录(增删改查、筛选、透视统计)、跑工作流、处理审批待办、操作自定义页面和角色权限、上传文件
应用修改 — 对已有应用做精确的局部修改(加字段、改视图、调流程等)
配合 AI 使用,可以用自然语言驱动整个 HAP 平台的操作。
安装
使用前提:开启组织的 CLI 访问权限
只有组织开启了 CLI 访问权限,hap 才能访问该组织的数据。请组织管理员前往「组织管理后台 → 安全 → 数据与访问 → CLI 访问策略」开启允许访问开关。未开启时命令会被拦截,管理员开启后直接重跑命令即可。
可用 hap auth list-my-orgs 查看各组织的开启状态(CLI:on/off)。
登录
浏览器流程会打开 HAP 登录页并捕获令牌。如果 CLI 收不到回调(无 GUI、网络受限),中断命令即可回退到粘贴登录页显示的令牌。
多环境 / 多账号
可同时授权多个环境(Mingdao SaaS、Nocoly、私有部署)与多个账号,各存成一个具名档案,长期共存、随时切换:
档案选择优先级:--profile > 环境变量 HAP_PROFILE > 当前档案。
选定组织和应用
hap auth set-current-org 切换默认组织;切换到不同组织时会同时清除默认应用(应用从属于组织)。之后用 hap app select 重新选择默认应用。
浏览工作表与记录
JSON 输出
所有命令都支持 --json,便于脚本处理。
默认应用与组织
任何需要 --app-id 的命令解析顺序:
命令显式传入的
--app-idhap app select APP_ID保存的默认应用仍为空时报错并提示设置默认应用
hap auth set-current-org 切换默认组织;切到不同组织时会同时清除默认应用。
REPL 模式
命令一览
每层都可以用
hap <group> --help查看完整子命令。
auth — 认证与会话
| 命令 | 说明 |
|---|---|
auth login [SERVER] | 浏览器登录(--token 非交互;--profile NAME 存为具名档案;--force 重指向已有名字) |
auth accounts | 列出所有环境/账号,当前标 * |
auth use NAME | 切换当前使用的环境/账号 |
auth logout | 登出当前账号(-p NAME 指定,-a/--all 全部) |
auth whoami | 当前用户、当前环境/账号与当前组织 |
auth list-my-orgs | 当前账号所属组织(当前标 *,显示 CLI 访问权限开关状态 CLI:on/off) |
auth set-current-org ORG_ID | 切换默认组织(切到不同组织时清除默认应用) |
app — 应用管理
| 命令 | 说明 |
|---|---|
app list | 列出组织下的应用(默认应用以 * 高亮) |
app list-managed | 当前用户作为管理员的应用 |
app info APP_ID | 应用详情(含分组、工作表、自定义页面) |
app create / update / delete | 应用生命周期 |
app select APP_ID / app unselect | 设置/清除默认应用 |
app create-section / edit-section / delete-section | 分组管理 |
app sort-sections / sort-worksheets | 重排分组 / 分组内工作表顺序 |
app create-item | 批量创建空白工作表/自定义页面 |
app backup / export / exports / backup-logs | 备份与导出 |
app usage / logs | 使用统计与操作日志 |
app role … | 角色 CRUD、权限、成员、leave-all、申请 |
app optionset … | 选项集 CRUD 与跨应用迁移 |
app knowledge list / search | 应用知识库 |
worksheet — 工作表、视图、自定义动作、统计图
| 命令 |
|---|
