@acomo/cli 1.0.11 → 1.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/AGENTS.md +142 -0
  2. package/README.md +11 -21
  3. package/dist/index.js +1542 -217
  4. package/dist/index.js.map +4 -4
  5. package/package.json +11 -5
  6. package/bin/acomo +0 -2
package/AGENTS.md ADDED
@@ -0,0 +1,142 @@
1
+ # AGENTS.md - acomo CLI Agent Guide
2
+
3
+ acomo CLI は acomo ワークフロー管理プラットフォームの公式 CLI です。
4
+ 全ての acomo API をコマンドラインから呼び出せます。
5
+
6
+ ## 認証
7
+
8
+ アクセストークンはブラウザで acomo にログインした後に入手し、CLI で保持します。
9
+
10
+ ```bash
11
+ # 環境変数で認証（推奨・非インタラクティブ）
12
+ export ACOMO_ACCESS_TOKEN="your-token"
13
+ export ACOMO_TENANT_ID="your-tenant-id"
14
+
15
+ # または login で保存
16
+ acomo login --tenant-id <tenantId> --access-token <accessToken>
17
+ ```
18
+
19
+ | 環境変数 | 説明 | 必須 |
20
+ | -------------------- | ----------------------------------------------- | ---- |
21
+ | `ACOMO_ACCESS_TOKEN` | アクセストークン | Yes |
22
+ | `ACOMO_TENANT_ID` | テナント ID | Yes |
23
+ | `ACOMO_BASE_URL` | API Base URL（デフォルト: `https://acomo.app`） | No |
24
+
25
+ ## 出力形式
26
+
27
+ - **TTY（ターミナル直接）**: デフォルトは `text`
28
+ - **パイプ/リダイレクト**: デフォルトは `json`（自動検出）
29
+ - **明示指定**: `--format json` または `--format text`
30
+
31
+ AI エージェントは通常パイプ経由で呼び出すため、自動的に JSON が返されます。
32
+
33
+ ## コマンドの使い方
34
+
35
+ ```bash
36
+ acomo <operationId> [JSON引数]
37
+ ```
38
+
39
+ ### パラメータの渡し方
40
+
41
+ ```bash
42
+ # 位置引数として
43
+ acomo <operationId> '{"key": "value"}'
44
+
45
+ # stdin から
46
+ echo '{"key": "value"}' | acomo <operationId>
47
+
48
+ # ファイルから
49
+ acomo <operationId> < params.json
50
+ ```
51
+
52
+ ### パラメータの確認
53
+
54
+ 各コマンドの必須/任意パラメータは `--help` で確認できます。
55
+
56
+ ```bash
57
+ acomo <operationId> --help
58
+ ```
59
+
60
+ ### コマンド一覧
61
+
62
+ ```bash
63
+ acomo --help
64
+ ```
65
+
66
+ ## 終了コード
67
+
68
+ | Code | 意味 |
69
+ | ---- | --------------------------------------------------- |
70
+ | 0 | 成功 |
71
+ | 1 | 一般エラー（サーバーエラーなど） |
72
+ | 2 | 認証エラー（401/403） |
73
+ | 3 | バリデーションエラー（パラメータ不足、不正な JSON） |
74
+ | 4 | リソース未検出（404） |
75
+
76
+ ## エラー出力形式
77
+
78
+ JSON モード（パイプ時のデフォルト）では、エラーは stderr に JSON で出力されます。
79
+
80
+ ```json
81
+ {
82
+ "error": true,
83
+ "code": "AUTH_REQUIRED | FORBIDDEN | NOT_FOUND | API_ERROR | VALIDATION_ERROR | INVALID_INPUT | UNKNOWN_ERROR",
84
+ "status": 401,
85
+ "message": "エラーメッセージ",
86
+ "suggestion": "対処方法（該当する場合）"
87
+ }
88
+ ```
89
+
90
+ ## 主要なワークフロー
91
+
92
+ ### モデル操作
93
+
94
+ ```bash
95
+ # モデル一覧
96
+ acomo listWorkflowModels
97
+
98
+ # フィルタ付き取得
99
+ acomo listWorkflowModels '{"filter":"{\"name\":{\"contains\":\"申請\"}}","take":"10"}'
100
+
101
+ # 特定のモデルを取得
102
+ acomo getWorkflowModel '{"modelId":"model-id"}'
103
+
104
+ # モデルを作成
105
+ acomo createWorkflowModel '{"createModelDto":{"name":"モデル名","definition":{},"dataSchema":{},"policy":{}}}'
106
+ ```
107
+
108
+ ### プロセス操作
109
+
110
+ ```bash
111
+ # プロセス一覧
112
+ acomo listWorkflowProcesses
113
+
114
+ # プロセスを開始
115
+ acomo startWorkflowProcess '{"modelId":"model-id"}'
116
+
117
+ # プロセスを承認
118
+ acomo approveWorkflowProcess '{"processId":"process-id"}'
119
+
120
+ # プロセスを却下
121
+ acomo rejectWorkflowProcess '{"processId":"process-id"}'
122
+ ```
123
+
124
+ ### ユーザー・テナント情報
125
+
126
+ ```bash
127
+ # 現在のユーザー
128
+ acomo getCurrentUser
129
+
130
+ # 現在のテナント
131
+ acomo getCurrentTenant
132
+
133
+ # ユーザー一覧
134
+ acomo listUsers
135
+ ```
136
+
137
+ ## Tips
138
+
139
+ 1. パラメータ情報は `--help` で確認: `acomo <command> --help`
140
+ 2. エラーハンドリングは終了コードを使用
141
+ 3. JSON 出力はパイプ経由で自動有効化
142
+ 4. 全コマンド一覧は `acomo --help` で確認
package/README.md CHANGED
@@ -12,12 +12,14 @@ npm install -g @acomo/cli
12
12
 
13
13
  ### 1. ログイン
14
14
 
15
+ アクセストークンはブラウザで acomo にログインした後に入手し、CLI で指定して保存します。
16
+
15
17
  ```bash
16
- # アクセストークンでログイン（推奨）
17
- acomo login --tenant-id <your-tenant-id> --token <your-access-token>
18
+ # オプションで指定
19
+ acomo login --tenant-id <your-tenant-id> --access-token <your-access-token>
18
20
 
19
- # または、メール/パスワードでログイン
20
- acomo login --tenant-id <your-tenant-id>
21
+ # または対話形式（baseUrl / tenantId / accessToken をプロンプトで入力。既存設定はデフォルト表示され Enter でそのまま採用）
22
+ acomo login
21
23
  ```
22
24
 
23
25
  ### 2. API を呼び出す
@@ -39,26 +41,16 @@ acomo listWorkflowModels '{"filter":"published","take":10}'
39
41
 
40
42
  #### アクセストークンでログイン
41
43
 
42
- ```bash
43
- acomo login --tenant-id <tenant-id> --token <access-token>
44
- ```
45
-
46
- Web 画面などで取得したアクセストークンを直接指定できます。
47
-
48
- #### メール/パスワードでログイン
44
+ アクセストークンはブラウザで acomo にログインした後に取得できます。取得したトークンを CLI で指定して保存します。
49
45
 
50
46
  ```bash
51
- # オプション指定
52
- acomo login --tenant-id <tenant-id> --email user@example.com --password pass123
53
-
54
- # インタラクティブ入力
55
- acomo login --tenant-id <tenant-id>
47
+ acomo login --tenant-id <tenant-id> --access-token <access-token>
56
48
  ```
57
49
 
58
- #### カスタム URL を指定
50
+ #### baseUrl を指定する
59
51
 
60
52
  ```bash
61
- acomo login --url https://custom.acomo.app --tenant-id <tenant-id> --token <token>
53
+ acomo login --base-url https://custom.acomo.app --tenant-id <tenant-id> --access-token <access-token>
62
54
  ```
63
55
 
64
56
  ### API 呼び出し
@@ -179,7 +171,6 @@ acomo getMyOrganization
179
171
  | `ACOMO_ACCESS_TOKEN` | アクセストークン | Yes | - |
180
172
  | `ACOMO_TENANT_ID` | テナント ID | Yes | - |
181
173
  | `ACOMO_BASE_URL` | API の Base URL | No | `https://acomo.app` |
182
- | `ACOMO_EMAIL` | メールアドレス | No | - |
183
174
 
184
175
  環境変数を設定しておけば、`acomo login` なしで直接 API を呼び出せます。
185
176
 
@@ -204,8 +195,7 @@ CLI オプションや環境変数が指定されている場合、設定ファ
204
195
  {
205
196
  "baseUrl": "https://acomo.app",
206
197
  "tenantId": "your-tenant-id",
207
- "accessToken": "your-access-token",
208
- "email": "user@example.com"
198
+ "accessToken": "your-access-token"
209
199
  }
210
200
  ```
211
201