acomo

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

acomo CLI / API 標準ガイド

acomo CLI / API 标准指南

acomo はワークフロー管理プラットフォームです。このスキルは acomo CLI と公開 API の標準的な使い方（モデル一覧・モデル定義取得・プロセス開始・保存・提出・承認・却下・差し戻しなど）を案内します。

acomo是一款工作流管理平台。本指南将介绍acomo CLI与公开API的标准使用方法（模型列表、获取模型定义、流程启动、保存、提交、审批、驳回、退回等）。

前提・実行環境

前提・运行环境

acomo CLI が実行できる環境（PATH に
```
acomo
```
が存在すること）を前提とします。
エージェントが CLI を実行する場合、リモートサンドボックス等ではローカルの
```
~/.acomo/config.json
```
や環境変数が自動継承されないことがあります。CI・エージェント実行時は環境変数（
```
ACOMO_ACCESS_TOKEN
```
,
```
ACOMO_TENANT_ID
```
,
```
ACOMO_BASE_URL
```
）の設定を推奨します。
認証未設定時も API コマンドは存在し、実行時に終了コード 2 と stderr の
```
AUTH_REQUIRED
```
で失敗します。その場合はユーザーに再ログイン（または環境変数設定）を促してください。

可运行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

の設定

出现认证错误（未设置认证、401/403、退出码2）时，请勿尝试自行解决。 请立即提示用户登录，并中断处理。

执行

acomo login

，或设置环境变量

ACOMO_ACCESS_TOKEN

ACOMO_TENANT_ID

認証

认证

ローカル利用:
```
acomo login
```
で
```
~/.acomo/config.json
```
に永続保存。
CI・エージェント環境: 環境変数での認証を推奨。

アクセストークンはブラウザで acomo にログインした後に入手し、CLI で指定する。

bash

undefined

本地使用: 通过
```
acomo login
```
将认证信息永久保存至
```
~/.acomo/config.json
```
。
CI及Agent环境: 推荐使用环境变量进行认证。

访问令牌需在浏览器登录acomo后获取，并在CLI中指定。

bash

undefined

環境変数で認証（非インタラクティブ向け）

环境变量认证（适用于非交互式场景）

export ACOMO_ACCESS_TOKEN="your-token" export ACOMO_TENANT_ID="your-tenant-id"

または login で保存

或通过login命令保存

acomo login --tenant-id <tenantId> --access-token <accessToken>


| 環境変数             | 説明                                            | 必須 |
| -------------------- | ----------------------------------------------- | ---- |
| `ACOMO_ACCESS_TOKEN` | アクセストークン                                | Yes  |
| `ACOMO_TENANT_ID`    | テナント ID                                     | Yes  |
| `ACOMO_BASE_URL`     | API Base URL（省略時: `https://acomo.app`）     | No   |

CLI の出力は JSON です。パラメータは `acomo <operationId> --help` で確認する。

acomo login --tenant-id <tenantId> --access-token <accessToken>


| 环境变量             | 说明                                            | 必填 |
| -------------------- | ----------------------------------------------- | ---- |
| `ACOMO_ACCESS_TOKEN` | 访问令牌                                        | Yes  |
| `ACOMO_TENANT_ID`    | 租户 ID                                         | Yes  |
| `ACOMO_BASE_URL`     | API Base URL（默认值: `https://acomo.app`）     | No   |

CLI的输出为JSON格式。参数可通过`acomo <operationId> --help`查看。

呼び出し形式

调用格式

bash

acomo <operationId> [--option value...] [body-json]

path/query パラメータ →
```
--name value
```
形式の named option
リクエストボディ → 位置引数の JSON 文字列（または stdin）

bash

undefined

bash

acomo <operationId> [--option value...] [body-json]

路径/查询参数 →
```
--name value
```
格式的命名选项
请求体 → 位置参数的JSON字符串（或通过stdin传入）

bash

undefined

path param のみ（GET など）

仅含路径参数（如GET请求）

acomo getWorkflowModel --modelId <ID>

query params

查询参数

acomo listWorkflowModels --take 10 --filter '{"name":{"contains":"申請"}}'

acomo listWorkflowModels --take 10 --filter '{"name":{"contains":"申请"}}'

body のみ（POST）

仅含请求体（如POST请求）

acomo createWorkflowModel '{"name":"経費申請","definition":{},"dataSchema":{},"policy":{}}'

acomo createWorkflowModel '{"name":"经费申请","definition":{},"dataSchema":{},"policy":{}}'

path param + body（PUT）

路径参数 + 请求体（如PUT请求）

acomo saveWorkflowModel --modelId <ID> '{"name":"経費申請","definition":{},"dataSchema":{},"policy":{}}'

acomo saveWorkflowModel --modelId <ID> '{"name":"经费申请","definition":{},"dataSchema":{},"policy":{}}'

stdin から body を渡す

通过stdin传入请求体

echo '{"name":"経費申請","definition":{},"dataSchema":{},"policy":{}}' | acomo createWorkflowModel

undefined

echo '{"name":"经费申请","definition":{},"dataSchema":{},"policy":{}}' | acomo createWorkflowModel

undefined

標準フロー

标准流程

モデル一覧:

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

を検討する。

模型列表: 使用

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`

プロセス操作では、タスクノードでは dataSchema に沿ったデータを

saveWorkflowProcess

の body の

data

フィールドで送る。遷移は submit / approve / reject / revert で実行する。policy の write/read に従い、現在ノードで編集可能な項目だけを扱う。

用途	命令
模型列表	`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`

流程操作中，在任务节点需按照dataSchema的要求，将数据通过

saveWorkflowProcess

请求体的

data

字段发送。流程流转通过submit / approve / reject / revert执行。需遵循policy的读写权限，仅处理当前节点可编辑的项目。

補足

补充说明

データ構造（definition / dataSchema / policy / 条件式）の詳細は reference.md を参照する。
全コマンド一覧は
```
acomo --help
```
で確認する。

数据结构（definition / dataSchema / policy / 条件表达式）的详细内容请参考reference.md。
所有命令列表可通过
```
acomo --help
```
查看。