关于 acomo
面向使用 acomo CLI 和公开 API 管理工作流的 Agent 与用户,介绍模型查询及流程操作,涵盖启动、提交、审批、驳回和退回。
主要功能
- 01列出并查看工作流模型
- 02启动并保存流程
- 03提交、审批、驳回或退回
- 04通过登录或环境变量认证
- 05以 JSON 获取命令输出
适用场景
- 01查找工作流模型并查看其定义
- 02启动流程并保存数据
- 03审批、驳回或退回流程
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ progress-all/ acomo-skills --skill acomo安装后在 Claude Code 中输入/acomo确认已加载。
附带文件reference.md
详细介绍
acomo CLI / API 标准指南
acomo 是一个工作流管理平台。本指南介绍 acomo CLI 和公开 API 的标准用法(模型列表、获取模型定义、启动流程、保存、提交、批准、驳回、退回等)。
前提与运行环境
- 需要在能够运行 acomo CLI 的环境中使用(PATH 中存在
acomo)。 - Agent 运行 CLI 时,在远程沙盒等环境中,本地的
~/.acomo/config.json或环境变量可能不会自动继承。在 CI 或 Agent 运行时,建议设置环境变量(ACOMO_ACCESS_TOKEN,ACOMO_TENANT_ID,ACOMO_BASE_URL)。 - 未设置认证时,API 命令仍然存在,但运行时会以退出代码 2 失败,并在 stderr 中显示
AUTH_REQUIRED。此时请提示用户重新登录(或设置环境变量)。
认证错误的处理
如果出现认证错误(未设置认证、401/403、退出代码 2),不要尝试通过反复试错来解决。 请立即提示用户登录,并中止处理。
- 运行
acomo login,或设置环境变量ACOMO_ACCESS_TOKEN,ACOMO_TENANT_ID
认证
- 本地使用:通过
acomo login将认证信息持久保存到~/.acomo/config.json。 - CI 和 Agent 环境:建议使用环境变量进行认证。
在浏览器中登录 acomo 后获取访问令牌,并在 CLI 中指定。
# 環境変数で認証(非インタラクティブ向け)
export ACOMO_ACCESS_TOKEN="your-token"
export ACOMO_TENANT_ID="your-tenant-id"
# または login で保存
acomo login --tenant-id <tenantId> --access-token <accessToken>
| 环境变量 | 说明 | 必填 |
|---|---|---|
ACOMO_ACCESS_TOKEN | 访问令牌 | Yes |
ACOMO_TENANT_ID | 租户 ID | Yes |
ACOMO_BASE_URL | API 基础 URL(省略时:https://acomo.app) | No |
CLI 的输出为 JSON。使用 acomo <operationId> --help 查看参数。
调用格式
acomo <operationId> [--option value...] [body-json]
- path/query 参数 → 使用
--name value格式的命名选项 - 请求体 → 位置参数中的 JSON 字符串(或 stdin)
# path param のみ(GET など)
acomo getWorkflowModel --modelId <ID>
# query params
acomo listWorkflowModels --take 10 --filter '{"name":{"contains":"申請"}}'
# body のみ(POST)
acomo createWorkflowModel '{"name":"経費申請","definition":{},"dataSchema":{},"policy":{}}'
# path param + body(PUT)
acomo saveWorkflowModel --modelId <ID> '{"name":"経費申請","definition":{},"dataSchema":{},"policy":{}}'
# stdin から body を渡す
echo '{"name":"経費申請","definition":{},"dataSchema":{},"policy":{}}' | acomo createWorkflowModel
标准流程
- 模型列表:使用
acomo listWorkflowModels查找目标模型。筛选示例:acomo listWorkflowModels --take 10 --filter '{"name":{"contains":"申請"}}' - 模型定义:使用
acomo getWorkflowModel --modelId <ID>获取 definition / dataSchema / policy 的 JSON。 - 流程操作:根据需要使用
startWorkflowProcess/saveWorkflowProcess/submitWorkflowProcess/submitWorkflowProcessWithNodeId/approveWorkflowProcess/rejectWorkflowProcess/revertWorkflowProcess。查看自己的流程列表时,可考虑使用listMyProcesses或listProcessWithNodeActions。
常用命令速查
| 用途 | 命令 |
|---|---|
| 模型列表 | listWorkflowModels |
| 获取模型定义 | getWorkflowModel --modelId <ID> |
| 编辑中的模型 | getWorkflowModelWithLatestModelHistory --modelId <ID> |
| 启动流程 | startWorkflowProcess --modelId <ID> |
| 保存数据 | saveWorkflowProcess --processId <ID> '{"data":{...}}' |
| 提交 | submitWorkflowProcess --processId <ID> |
| 批准 | approveWorkflowProcess --processId <ID> |
| 驳回 | rejectWorkflowProcess --processId <ID> |
| 退回 | revertWorkflowProcess --processId <ID> --nodeId <nodeId> |
| 查看自己的流程列表 | listMyProcesses / listProcessWithNodeActions |
| 获取自己的流程 | getMyProcesses / getProcessWithNodeActions |
操作流程时,在任务节点中,应在 saveWorkflowProcess 请求体的 data 字段中提交符合 dataSchema 的数据。使用 submit / approve / reject / revert 执行流转。遵循 policy 中的 write/read 设置,仅处理当前节点可编辑的项目。
补充说明
- 有关数据结构(definition / dataSchema / policy / 条件表达式)的详细信息,请参阅 reference.md。
- 使用
acomo --help查看所有命令。
评论
支持 Markdown