@controllerai/cli 0.2.20 → 0.2.21
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.
- package/dist/api/client.js +0 -32
- package/dist/api/client.js.map +1 -1
- package/dist/commands/agent.js +8 -101
- package/dist/commands/agent.js.map +1 -1
- package/dist/commands/expr.js +10 -3
- package/dist/commands/expr.js.map +1 -1
- package/dist/commands/integration.js +2 -8
- package/dist/commands/integration.js.map +1 -1
- package/dist/commands/workflow.js +6 -7
- package/dist/commands/workflow.js.map +1 -1
- package/dist/errors.js +2 -5
- package/dist/errors.js.map +1 -1
- package/package.json +6 -4
- package/skills/controllerai-agents/SKILL.md +107 -26
- package/skills/controllerai-agents/references/instructions-and-versioning.md +32 -34
- package/skills/controllerai-ai-nodes/SKILL.md +83 -10
- package/skills/controllerai-ai-nodes/references/selection-and-testing.md +44 -26
- package/skills/controllerai-data/SKILL.md +106 -34
- package/skills/controllerai-data/references/data-rails.md +24 -26
- package/skills/controllerai-expressions/SKILL.md +82 -29
- package/skills/controllerai-expressions/references/dsl-and-recipes.md +42 -40
- package/skills/controllerai-flow-control/SKILL.md +104 -21
- package/skills/controllerai-flow-control/references/patterns.md +23 -60
- package/skills/controllerai-integration-actions/SKILL.md +84 -11
- package/skills/controllerai-node-config/SKILL.md +108 -18
- package/skills/controllerai-node-config/references/prop-and-readiness.md +28 -78
- package/skills/controllerai-runs/SKILL.md +82 -25
- package/skills/controllerai-runs/references/debugging.md +24 -22
- package/skills/controllerai-start/SKILL.md +61 -35
- package/skills/controllerai-start/references/mcp-tool-map.md +20 -21
- package/skills/controllerai-triggers/SKILL.md +113 -16
- package/skills/controllerai-triggers/references/lifecycle.md +36 -48
- package/skills/controllerai-workflows/SKILL.md +105 -25
- package/skills/controllerai-workflows/references/command-map.md +19 -44
- package/skills/manifest.json +80 -137
- package/skills-mcp/controllerai-agents/SKILL.md +121 -0
- package/skills-mcp/controllerai-agents/references/instructions-and-versioning.md +76 -0
- package/skills-mcp/controllerai-ai-nodes/SKILL.md +92 -0
- package/skills-mcp/controllerai-ai-nodes/references/selection-and-testing.md +66 -0
- package/skills-mcp/controllerai-data/SKILL.md +119 -0
- package/skills-mcp/controllerai-data/references/data-rails.md +45 -0
- package/skills-mcp/controllerai-expressions/SKILL.md +98 -0
- package/skills-mcp/controllerai-expressions/references/dsl-and-recipes.md +136 -0
- package/skills-mcp/controllerai-flow-control/SKILL.md +114 -0
- package/skills-mcp/controllerai-flow-control/references/patterns.md +83 -0
- package/skills-mcp/controllerai-integration-actions/SKILL.md +89 -0
- package/skills-mcp/controllerai-node-config/SKILL.md +106 -0
- package/skills-mcp/controllerai-node-config/references/prop-and-readiness.md +49 -0
- package/skills-mcp/controllerai-runs/SKILL.md +88 -0
- package/skills-mcp/controllerai-runs/references/debugging.md +53 -0
- package/skills-mcp/controllerai-start/SKILL.md +80 -0
- package/skills-mcp/controllerai-start/references/mcp-tool-map.md +175 -0
- package/skills-mcp/controllerai-triggers/SKILL.md +112 -0
- package/skills-mcp/controllerai-triggers/references/lifecycle.md +59 -0
- package/skills-mcp/controllerai-workflows/SKILL.md +109 -0
- package/skills-mcp/controllerai-workflows/references/command-map.md +1 -0
- package/skills-mcp/manifest.json +189 -0
- package/skills/controllerai-agents/references/command-reference.md +0 -205
- package/skills/controllerai-ai-nodes/references/command-reference.md +0 -98
- package/skills/controllerai-data/references/command-reference.md +0 -177
- package/skills/controllerai-expressions/references/command-reference.md +0 -166
- package/skills/controllerai-flow-control/references/command-reference.md +0 -171
- package/skills/controllerai-integration-actions/references/command-reference.md +0 -118
- package/skills/controllerai-node-config/references/command-reference.md +0 -186
- package/skills/controllerai-runs/references/command-reference.md +0 -113
- package/skills/controllerai-triggers/references/command-reference.md +0 -215
- package/skills/controllerai-workflows/references/command-reference.md +0 -118
|
@@ -1,8 +1,9 @@
|
|
|
1
|
+
<!-- generated from .claude/skills by cli/scripts/render-skills.mjs; edit the source -->
|
|
1
2
|
<!-- Generated by cli/scripts/generate-mcp-tool-map.mjs; do not edit by hand. -->
|
|
2
3
|
|
|
3
4
|
# CLI to typed MCP tool map
|
|
4
5
|
|
|
5
|
-
This registry-derived map covers
|
|
6
|
+
This registry-derived map covers 165 CLI commands and 149 typed MCP tools. CLI examples remain the canonical grammar; typed MCP calls use the tool and camelCase parameters shown here. Global `--json` and `--api-url` flags are host-controlled and omitted.
|
|
6
7
|
|
|
7
8
|
| `cai` command | MCP tool | Parameter mapping | Notes |
|
|
8
9
|
| --- | --- | --- | --- |
|
|
@@ -25,6 +26,7 @@ This registry-derived map covers 162 CLI commands and 149 typed MCP tools. CLI e
|
|
|
25
26
|
| `cai agent publish` | `agent_publish` | `<agentId>` → `agentId`; `--name` → `name` | — |
|
|
26
27
|
| `cai agent publish-preflight` | `agent_publish_preflight` | `<agentId>` → `agentId` | — |
|
|
27
28
|
| `cai agent remove-tool` | `agent_tool_remove` | `<agentId>` → `agentId`; `--tool` → `toolId` | — |
|
|
29
|
+
| `agent setup` (CLI only) | — | — | dropped: Configures local coding assistants on the user machine; nothing to do on a hosted server. |
|
|
28
30
|
| `cai agent test` | `agent_test` | `<agentId>` → `agentId`; `--message` → `message`; `--model` → `model`; `--timeout` → `waitSeconds`; `--title` → `title`; `--draft` → `rail=draft`; `--live` → `rail=live` | `waitSeconds` default 60, max 120 |
|
|
29
31
|
| `cai agent tools` | `agent_tool_list` | `<agentId>` → `agentId` | — |
|
|
30
32
|
| `cai agent update` | `agent_set_enabled`<br>`agent_update` | `agent_set_enabled`: `<agentId>` → `agentId`; `--enabled` / `--disabled` → `enabled`<br>`agent_update`: `<agentId>` → `agentId`; `--instructions` / `--instructions-file` → `instructions` (inline content); `--name` → `name` | split across typed tools |
|
|
@@ -32,24 +34,24 @@ This registry-derived map covers 162 CLI commands and 149 typed MCP tools. CLI e
|
|
|
32
34
|
| `cai agent versions` | `agent_version_list` | `<agentId>` → `agentId` | — |
|
|
33
35
|
| `cai agent visibility` | `agent_visibility_set` | `<agentId>` → `agentId`; `--value` → `value` | — |
|
|
34
36
|
| `cai approval resume` | `approval_resume` | `<id>` → `approvalId`; `waitSeconds` (MCP-only) → `waitSeconds` | `waitSeconds` default 60, max 120 |
|
|
35
|
-
| `
|
|
36
|
-
| `
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
37
|
+
| `auth key` (CLI only) | — | — | dropped: Mints a long-lived local credential and is not an MCP account operation. |
|
|
38
|
+
| `auth login` (CLI only) | — | — | dropped: Starts a local device-code login even though the MCP request is already OAuth-authorized. |
|
|
39
|
+
| `auth logout` (CLI only) | — | — | dropped: Deletes local CLI credentials; it is not integration connection revocation. |
|
|
40
|
+
| `auth password` (CLI only) | — | — | dropped: Accepts a development email/password credential on the local machine. |
|
|
39
41
|
| `cai auth status` | `account_status` | — | hosted: The host reports the authenticated grant and combines it with server health facts. |
|
|
40
|
-
| `
|
|
42
|
+
| `auth token` (CLI only) | — | — | dropped: Writes a bearer token into local CLI configuration. |
|
|
41
43
|
| `cai branch add` | `branch_add` | `<nodeId>` → `nodeId`; `--allow-duplicate` → `allowDuplicate`; `--condition-json` → `conditionJson`; `--js` / `--js-file` → `js` (inline content); `--name` → `name`; `--workflow` → `workflowId` | — |
|
|
42
44
|
| `cai branch connect` | `branch_connect` | `<nodeId>` → `nodeId`; `--flow` → `flow`; `--route` → `branchId`; `--to` → `to`; `--workflow` → `workflowId` | — |
|
|
43
45
|
| `cai branch delete` | `branch_delete` | `<nodeId>` → `nodeId`; `--route` → `branchId`; `--workflow` → `workflowId` | — |
|
|
44
46
|
| `cai branch list` | `branch_list` | `<nodeId>` → `nodeId`; `--workflow` → `workflowId` | — |
|
|
45
47
|
| `cai branch reorder` | `branch_reorder` | `<nodeId>` → `nodeId`; `--order` → `order`; `--workflow` → `workflowId` | — |
|
|
46
48
|
| `cai branch update` | `branch_update` | `<nodeId>` → `nodeId`; `--condition-json` → `conditionJson`; `--js` / `--js-file` → `js` (inline content); `--name` → `name`; `--route` → `branchId`; `--workflow` → `workflowId` | — |
|
|
47
|
-
| `
|
|
48
|
-
| `
|
|
49
|
+
| `config reset` (CLI only) | — | — | dropped: Clears a local workflow pin; typed MCP calls are stateless. |
|
|
50
|
+
| `connect` (CLI only) | — | — | dropped: Installs local skills, opens a browser, and verifies a local project. |
|
|
49
51
|
| `cai connection connect` | `connection_connect_url` | `<nodeSlug>` → `nodeSlug` | — |
|
|
50
52
|
| `cai connection delete` | `connection_delete` | `<connectionId>` → `connectionId` | — |
|
|
51
53
|
| `cai connection list` | `connection_list` | `--integration` → `integration` | — |
|
|
52
|
-
| `
|
|
54
|
+
| `connection request` (CLI only) | — | — | dropped: Posts a connect card into build chat; connection_connect_url supplies the hosted outcome. |
|
|
53
55
|
| `cai connection update` | `connection_update` | `<connectionId>` → `connectionId`; `--name` → `displayName`; `--default` / `--no-default` → `isDefault` | — |
|
|
54
56
|
| `cai data collection create` | `schema_type_create` | `<dataType>` → `name`; `--display` → `display`; `--field` → `field`; `--from-json` → `fromJson` (inline content); `--workflow` → `workflowId` | merged: The CLI command is sugar over schema create; no separate collection-create route exists. |
|
|
55
57
|
| `cai data collections` | `data_collection_list` | `--env` → `env`; `--workflow` → `workflowId` | — |
|
|
@@ -63,6 +65,7 @@ This registry-derived map covers 162 CLI commands and 149 typed MCP tools. CLI e
|
|
|
63
65
|
| `cai data query` | `data_record_query` | `--env` → `env`; `--limit` → `limit`; `--offset` → `offset`; `--query` → `query`; `--type` → `type`; `--workflow` → `workflowId` | — |
|
|
64
66
|
| `cai data update` | `data_record_update` | `<recordId>` → `recordId`; `--env` → `env`; `--fields` → `fields`; `--type` → `type`; `--workflow` → `workflowId` | `env` required |
|
|
65
67
|
| `cai deps` | `dependency_map` | `--workflow` → `workflowId` | — |
|
|
68
|
+
| `docs` (CLI only) | — | — | dropped: Fetches documentation into a local terminal; hosted clients read guide_get or the docs site. |
|
|
66
69
|
| `cai doctor` | `account_status` | — | hosted: Local runtime checks do not apply; useful account and version facts are in account_status. |
|
|
67
70
|
| `cai events` | `event_list` | `--cursor` → `cursor`; `--limit` → `limit`; `--since` → `since`; `--type` → `type`; `--for-workflow` / `--workflow` → `workflowId` | — |
|
|
68
71
|
| `cai exec flow` | `execution_flow_get` | `<flowExecutionId>` → `flowExecutionId`; `--workflow` → `workflowId` | — |
|
|
@@ -107,7 +110,7 @@ This registry-derived map covers 162 CLI commands and 149 typed MCP tools. CLI e
|
|
|
107
110
|
| `cai node duplicate` | `node_duplicate` | `<nodeId>` → `nodeId`; `--workflow` → `workflowId` | — |
|
|
108
111
|
| `cai node enable-prop` | `node_optional_prop_set` | `<nodeId>` → `nodeId`; `--prop` → `prop`; `--workflow` → `workflowId`; `enabled` (MCP-only) → `enabled` | merged: The explicit enabled boolean replaces the separate enabling command. |
|
|
109
112
|
| `cai node get` | `node_get` | `<nodeId>` → `nodeId`; `--workflow` → `workflowId` | — |
|
|
110
|
-
| `cai node only-when` | `node_only_when_set` | `<nodeId>` → `nodeId`; `--clear` → `clear`; `--js` / `--js-file` → `js` (inline content); `--workflow` → `workflowId` | — |
|
|
113
|
+
| `cai node only-when` | `node_only_when_set` | `<nodeId>` → `nodeId`; `--clear` → `clear`; `--groups-json` → `groups`; `--js` / `--js-file` → `js` (inline content); `--workflow` → `workflowId` | — |
|
|
111
114
|
| `cai node optional-props` | `node_optional_prop_list` | `<nodeId>` → `nodeId`; `--workflow` → `workflowId` | — |
|
|
112
115
|
| `cai node options` | `node_prop_options` | `<nodeId>` → `nodeId`; `--for` → `for`; `--page` → `page`; `--prev-context` → `prevContext`; `--prop` → `prop`; `--query` → `query`; `--workflow` → `workflowId` | — |
|
|
113
116
|
| `cai node props` | `node_prop_list` | `<nodeId>` → `nodeId`; `--workflow` → `workflowId` | — |
|
|
@@ -121,19 +124,19 @@ This registry-derived map covers 162 CLI commands and 149 typed MCP tools. CLI e
|
|
|
121
124
|
| `cai run flow` | `run_flow` | `<flowId>` → `flowId`; `--confirm-live` → `confirmLive`; `--inputs` → `inputs`; `--target` → `target`; `--timeout` → `waitSeconds`; `--workflow` → `workflowId` | `waitSeconds` default 60, max 120 |
|
|
122
125
|
| `cai run inputs` | `run_inputs` | `<nodeIdOrFlowId>` → `nodeIdOrFlowId`; `--flow` → `flow`; `--workflow` → `workflowId` | — |
|
|
123
126
|
| `cai run node` | `run_node` | `<nodeId>` → `nodeId`; `--inputs` → `inputs`; `--timeout` → `waitSeconds`; `--workflow` → `workflowId` | `waitSeconds` default 60, max 120 |
|
|
124
|
-
| `
|
|
127
|
+
| `run workflow` (CLI only) | — | — | dropped: Excluded dead stub whose handler always throws NOT_IMPLEMENTED. |
|
|
125
128
|
| `cai schema create` | `schema_type_create` | `<name>` → `name`; `--display` → `display`; `--field` → `field`; `--from-json` → `fromJson` (inline content); `--workflow` → `workflowId` | — |
|
|
126
129
|
| `cai schema delete` | `schema_type_delete` | `<name>` → `name`; `--workflow` → `workflowId` | — |
|
|
127
130
|
| `cai schema get` | `schema_type_get` | `<name>` → `name`; `--workflow` → `workflowId` | — |
|
|
128
131
|
| `cai schema list` | `schema_type_list` | `--all` → `all`; `--workflow` → `workflowId` | — |
|
|
129
132
|
| `cai schema resolve` | `schema_type_resolve` | `<typeId>` → `typeId`; `--workflow` → `workflowId` | — |
|
|
130
133
|
| `cai schema update` | `schema_type_update` | `<name>` → `name`; `--display` → `display`; `--field` → `field`; `--from-json` → `fromJson` (inline content); `--workflow` → `workflowId` | — |
|
|
131
|
-
| `
|
|
134
|
+
| `signup` (CLI only) | — | — | dropped: The OAuth-authorized caller already has a provisioned account; root signup is local bootstrap. |
|
|
132
135
|
| `cai signup email` | `account_claim_start` | `<address>` → `email` | hosted: Uses the OAuth grant durable email-claim adapter instead of local CLI credential replacement. |
|
|
133
136
|
| `cai signup verify` | `account_claim_verify` | `<code>` → `code` | hosted: Uses the OAuth grant durable email verification adapter. |
|
|
134
|
-
| `
|
|
137
|
+
| `skills install` (CLI only) | — | — | dropped: Writes guidance into a caller local project, which the hosted server cannot access. |
|
|
135
138
|
| `cai skills status` | `guide_get`<br>`guide_list` | `guide_get`: `name` (MCP-only) → `name`<br>`guide_list`: — | hosted: guide_list and guide_get serve the bundled server guidance without inspecting a local project. |
|
|
136
|
-
| `
|
|
139
|
+
| `skills update` (CLI only) | — | — | dropped: Updates guidance files in a caller local project. |
|
|
137
140
|
| `cai trigger audit` | `trigger_audit` | `--workflow` → `workflowId` | — |
|
|
138
141
|
| `cai trigger create` | `trigger_create` | `--connection` → `connection`; `--dynamic-props-id` → `dynamicPropsId`; `--event` → `event`; `--flow` → `flow`; `--node` → `node`; `--props` → `props`; `--source-basis` → `sourceBasis`; `--workflow` → `workflowId` | — |
|
|
139
142
|
| `cai trigger delete` | `trigger_delete` | `<triggerId>` → `triggerId`; `--workflow` → `workflowId` | — |
|
|
@@ -149,9 +152,10 @@ This registry-derived map covers 162 CLI commands and 149 typed MCP tools. CLI e
|
|
|
149
152
|
| `cai trigger select-event` | `trigger_event_select` | `--event` → `eventId`; `--node` → `triggerNodeId`; `--workflow` → `workflowId` | — |
|
|
150
153
|
| `cai trigger set-enabled` | `trigger_set_enabled` | `<triggerId>` → `triggerId`; `--enable` / `--disable` → `enabled`; `--workflow` → `workflowId` | merged: The explicit enabled boolean combines the mutually exclusive enable and disable flags. |
|
|
151
154
|
| `cai trigger test-events` | `trigger_test_events_set` | `<triggerId>` → `triggerId`; `--acknowledge-dual-run` → `acknowledgeDualRun`; `--allow` / `--disallow` → `allowed`; `--workflow` → `workflowId` | — |
|
|
152
|
-
| `
|
|
155
|
+
| `upgrade` (CLI only) | — | — | dropped: Prints the local CLI upgrade command and updates local skills; nothing to do on a hosted server. |
|
|
156
|
+
| `use` (CLI only) | — | — | dropped: Persists a local workflow pin; every typed workflow call carries an explicit id. |
|
|
153
157
|
| `cai workflow create` | `workflow_create` | `--name` → `name` | — |
|
|
154
|
-
| `cai workflow delete` | `workflow_delete` | `<workflowId>`
|
|
158
|
+
| `cai workflow delete` | `workflow_delete` | `<workflowId>` → `workflowId` | CLI requires positional `<workflowId>`; `--workflow` does not replace it |
|
|
155
159
|
| `cai workflow document` | `workflow_document_get` | `--state` → `stateId`; `--workflow` → `workflowId` | — |
|
|
156
160
|
| `cai workflow duplicate` | `workflow_duplicate` | `<workflowId>` / `--workflow` → `workflowId` | — |
|
|
157
161
|
| `cai workflow get` | `workflow_get` | `<workflowId>` / `--workflow` → `workflowId` | — |
|
|
@@ -169,8 +173,3 @@ This registry-derived map covers 162 CLI commands and 149 typed MCP tools. CLI e
|
|
|
169
173
|
| `cai workflow validate` | `workflow_validate` | `--workflow` → `workflowId` | — |
|
|
170
174
|
| `cai workflow versions` | `workflow_version_list` | `<workflowId>` / `--workflow` → `workflowId` | — |
|
|
171
175
|
|
|
172
|
-
## Conversation files and compact history
|
|
173
|
-
|
|
174
|
-
`agent_conversation_file_add` accepts `conversationId`, `name`, `type`, and inline text `content`. `agent_conversation_file_list` returns both chat attachments and context files, with `cursor`, `limit`, and `search`. Read UTF-8 content using `agent_conversation_file_read`; retrieve original bytes through `agent_conversation_file_download`, which returns a temporary downloadable URL. Both take the conversation and file IDs.
|
|
175
|
-
|
|
176
|
-
Conversation history defaults to a compact, paginated message view. Use `limit` and `before`; `raw: true` is for SDK diagnostics only. On the CLI, the corresponding commands are `agent conversation add-file`, `files`, `read-file`, and `download-file --out <path>`. CLI upload uses `--file`, while MCP upload uses inline `content`.
|
|
@@ -1,28 +1,125 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: controllerai-triggers
|
|
3
|
-
description:
|
|
3
|
+
description: Discover, configure, create, capture, map, test, enable and debug Controller AI triggers: schedules, webhooks, email and app events. Use when an automation must start without a chat message, when a captured payload must become typed flow input, when replaying an event, or when asking why an automation did or did not start.
|
|
4
4
|
---
|
|
5
|
+
<!-- generated from .claude/skills by cli/scripts/render-skills.mjs; edit the source -->
|
|
5
6
|
|
|
6
|
-
#
|
|
7
|
+
# Triggers
|
|
7
8
|
|
|
8
|
-
|
|
9
|
+
## Use this when
|
|
9
10
|
|
|
10
|
-
|
|
11
|
+
- A workflow must start on a schedule, a webhook, an email or an app event.
|
|
12
|
+
- A captured event must become the typed input of a flow, or a trigger's mapping is wrong.
|
|
13
|
+
- A trigger must be paused, resumed, retired or replaced, or a run did not start.
|
|
11
14
|
|
|
12
|
-
|
|
13
|
-
2. Create/select the destination flow and define the inputs it needs.
|
|
14
|
-
3. Configure the trigger using the exact component identity. Choose selectors before dependent properties and bind any required connection.
|
|
15
|
-
4. Capture a representative event. Use the returned webhook URL, trigger email address or provider action; do not invent an endpoint.
|
|
16
|
-
5. Inspect/select the captured sample and map its fields into flow inputs using the actual expression context.
|
|
17
|
-
6. Replay the sample on development and verify received inputs, flow outputs and expected record or external effects.
|
|
18
|
-
7. When live operation is authorized, publish the workflow, enable the trigger as needed and verify an actual live event.
|
|
15
|
+
Flow inputs and mapping expressions belong to `controllerai-expressions`; reading a run belongs to `controllerai-runs`; publishing belongs to `controllerai-workflows`.
|
|
19
16
|
|
|
20
|
-
|
|
17
|
+
## How it works
|
|
21
18
|
|
|
22
|
-
|
|
19
|
+
**One trigger, one flow.** A trigger binds a source (node slug plus exact event key, its connection and props) to exactly one flow, and its payload does not populate that flow by itself: the flow needs declared inputs, and the mapping props live on the trigger canvas's run-subflow node (`runSubflowNodeId`, wired automatically, never connected by hand), one per flow input, synthesized after the inputs exist. Creating the source, capturing and selecting a sample, mapping, testing on development, publishing and verifying live are separate steps.
|
|
23
20
|
|
|
24
|
-
|
|
21
|
+
**Two rails, three switches.** Events are captured from the moment the source exists, and ordinary event execution runs the live release, so a trigger does not run live until the workflow is published; before that it can execute on development only through a replay or armed ambient dispatch. `set-enabled` (enable or disable) is the trigger's definition state and edits development only; the prior live trigger keeps running until an authorized publish. `test-events` (allow or disallow) sets a sticky permission bit for ambient development dispatch: real events then also execute the development canvas. `replay` targets one rail explicitly. The bit survives a disable (`devDispatchArmed` is enabled-and-allowed), and once the workflow is published with the trigger enabled on both rails and routable, every real event can execute on both rails (a schedule every interval), which is why publish refuses an armed trigger unless the user explicitly acknowledges dual dispatch.
|
|
25
22
|
|
|
26
|
-
|
|
23
|
+
**Four IDs.** The canvas `triggerId` addresses get, rename, set-enabled, delete and test-events. The numeric `backendTriggerId` addresses captured events and replay. The `triggerNodeId` selects the typed sample. The captured `eventId` addresses event, select-event and replay. Copy them from the responses; they are never interchangeable.
|
|
27
24
|
|
|
28
|
-
|
|
25
|
+
**Props are resolved, not guessed.** The props read returns a shape-correct `propsExample`, `readyForCreate`, and `unresolvedOptionProps`; unresolved required option props are omitted rather than filled with a plausible placeholder, and hidden props stay unset (they are provider reload plumbing). Option values are resolved by the options read with the same node, event, connection and configured values. The dynamic schema is identified by the response's `id`, passed back as `dynamicPropsId`; a selector that reloads props can mint a new one, so always pass the latest and keep every earlier configured value on each reload (registry events have no dynamic schema). Timer values are objects, `{"cron":{"cron":"0 9 * * *","timezone":"America/Chicago"}}` or `{"cron":{"intervalSeconds":900}}`, never a bare cron string.
|
|
26
|
+
|
|
27
|
+
**A sample makes the type.** A captured event becomes the trigger node's output type only when it is selected; the mapping props are bound after that, from the re-read expression context, and a payload without a platform data type can stay untyped.
|
|
28
|
+
|
|
29
|
+
## Rules
|
|
30
|
+
|
|
31
|
+
1. **The start condition is the user's decision.** Create a source only with an explicit `--source-basis`: `explicit-in-request`, `user-answer`, or `inferred-from-existing-workflow` when preserving an existing source. The backend rejects an assumption; when the request does not say when the automation runs, ask one focused question first.
|
|
32
|
+
2. **Copy the exact `nodeSlug` and `eventKey`** from the search result; never derive an event key from its display name, because keys are opaque and display names collide across providers.
|
|
33
|
+
3. **Ask for the timezone** when the user says "at 9am" without one, and never infer a production cadence from a test sample, whose timing is a test artifact.
|
|
34
|
+
4. **Repair in place.** Keep the trigger's canvas ID and source when fixing its mapping or readiness; replacing a trigger changes captured IDs and may change a webhook URL, so replace only when the source itself must change, then recapture every ID.
|
|
35
|
+
5. **Delete a retired start; disable a paused one.** "Stop starting itself", "retire" and "no longer" mean delete: a disabled trigger still exists and can be re-enabled, so it is not retired. Never delete the owning flow to remove a trigger (that destroys the graph and its callers), and pass exactly one state flag.
|
|
36
|
+
6. **Arm ambient dispatch only on the user's decision, and disarm when setup ends**, including a failed or abandoned setup. Capture needs no arming; arming executes a half-built development flow on real traffic, so explain that before adding the acknowledgement. Keeping both rails armed is an uncommon, explicit user choice, never a default, and routine tests use replay.
|
|
37
|
+
7. **Never mix the flag families or the acknowledgements.** `--enable|--disable`, `--allow|--disallow`, `--target dev|live`; `--acknowledge-dual-run` only while arming, `--acknowledge-dual-dispatch` only while publishing an armed trigger, `--confirm-live` only for one live replay. Never add an acknowledgement on your own initiative.
|
|
38
|
+
8. **Audit every trigger before a publish**, not only the one you touched; users forget starts left enabled or armed in other flows.
|
|
39
|
+
9. **A captured event is not a run.** For create or mapping work, verify received inputs, outputs and effects on a development replay; an event with no execution and an execution with empty inputs are different faults. Read-only diagnosis, a deletion (verified through the list and status) and a user-declined test need no replay.
|
|
40
|
+
10. **A draft-only request stops at development proof**, and a delete-only or disable-only task needs no replay.
|
|
41
|
+
|
|
42
|
+
## Recipes
|
|
43
|
+
|
|
44
|
+
### Discover and resolve
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
cai trigger search "<event intent>" --json
|
|
48
|
+
cai trigger search --node <nodeSlug> --events-per-node 50 --json
|
|
49
|
+
cai trigger props --node <nodeSlug> --event <eventKey> --connection <connectionId> --json
|
|
50
|
+
cai trigger options --node <nodeSlug> --event <eventKey> --prop <propName> --connection <connectionId> --configured '<configuredPropsJson>' --dynamic-props-id <dynamicPropsId> --query "<option label>" --json
|
|
51
|
+
cai trigger props --node <nodeSlug> --event <eventKey> --connection <connectionId> --configured '<configuredPropsJson>' --dynamic-props-id <dynamicPropsId> --json
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Omit the connection for a source without auth. Copy the returned option `value`, not its `label`, into the configured props, then re-read the props until `readyForCreate` is true. Use `--page` with the returned context (`--prev-context`) when a search does not find the option. A missing connection is handled as in `controllerai-node-config`: `cai connection list --node <nodeSlug> --json`, then `cai connection connect <nodeSlug> --no-open`.
|
|
55
|
+
|
|
56
|
+
### Create and map
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
cai trigger create --flow <targetFlowId> --node <nodeSlug> --event <eventKey> --source-basis <basis> --connection <connectionId> --props '<json>' --dynamic-props-id <dynamicPropsId> --json
|
|
60
|
+
cai trigger get <triggerId> --json
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
Capture every returned ID (`triggerId`, `backendTriggerId`, `triggerNodeId`, `runSubflowNodeId`) plus the `webhookUrl` or `emailAddress` when the source has one, and follow `nextSteps` in order: declare the flow inputs, capture and select a sample, then bind one mapping prop per input on the run-subflow node from its re-read expression context. Read-back is `get`; there is no describe command.
|
|
64
|
+
|
|
65
|
+
### Capture and select a sample
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
cai trigger events --trigger <backendTriggerId> --json
|
|
69
|
+
cai trigger event <eventId> --json
|
|
70
|
+
cai trigger select-event --node <triggerNodeId> --event <eventId> --json
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
A representative event has to reach the source: through the provider, the returned webhook URL or email address; never invent an endpoint. Inspect the payload before selecting it and re-read the run-subflow node's expression context after selecting.
|
|
74
|
+
|
|
75
|
+
### Arm ambient development dispatch (only on request)
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
cai trigger test-events <triggerId> --allow --acknowledge-dual-run --json
|
|
79
|
+
cai trigger test-events <triggerId> --disallow --json
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Arming makes every real event also execute the development canvas while it is half built; use it only when the user wants that after hearing it, and disarm at the end of setup.
|
|
83
|
+
|
|
84
|
+
### Pause, resume, retire
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
cai trigger set-enabled <triggerId> --enable --json
|
|
88
|
+
cai trigger set-enabled <triggerId> --disable --json
|
|
89
|
+
cai trigger delete <triggerId> --json
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Test, audit, publish
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
cai run flow <targetFlowId> --inputs <values.json> --json
|
|
96
|
+
cai trigger replay --trigger <backendTriggerId> --event <eventId> --target dev --json
|
|
97
|
+
cai exec tree <workflowExecutionId> --json
|
|
98
|
+
cai trigger audit --json
|
|
99
|
+
cai trigger list --json
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Run the target flow directly first, then replay one captured event through the development trigger path; a development replay never dispatches live but still calls real providers and spends usage. `--payload` replays a custom raw payload instead of `--event`. The audit reports coverage, armed development dispatch and double-run risk; the list and get reads show `devCanvasEnabled` at the top level and `deployment.liveCanvasEnabled`, `deployment.inLiveVersion`, `deployment.devDispatchArmed` and `deployment.dualDispatchLive` (live fields are null when no live canvas exists yet: never published, or this trigger added after the last publish). Publish through `controllerai-workflows` only for an authorized live change. A publish refused because a trigger is still armed is the designed backstop: disarm and republish; publishing armed needs the user's informed choice after hearing about double runs and double billing, and only then `cai workflow publish --acknowledge-dual-dispatch --json`.
|
|
103
|
+
|
|
104
|
+
### Verify live
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
cai trigger replay --trigger <backendTriggerId> --event <eventId> --target live --confirm-live --json
|
|
108
|
+
cai exec tree <workflowExecutionId> --json
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
A live replay executes the published workflow, calls live third-party actions and spends usage; it needs its own authorization and is optional.
|
|
112
|
+
|
|
113
|
+
## Verify
|
|
114
|
+
|
|
115
|
+
```bash
|
|
116
|
+
cai trigger get <triggerId> --json
|
|
117
|
+
cai trigger list --json
|
|
118
|
+
cai workflow status --json
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
The trigger, source, target flow, connection, props and mapping match the request; `devCanvasEnabled` and `deployment.liveCanvasEnabled` / `deployment.inLiveVersion` match the requested rail state; `deployment.devDispatchArmed` is false unless the user chose dual dispatch; for create or mapping work, the development replay's execution tree shows the flow receiving the mapped inputs and producing the expected effect; for a deletion, the list no longer shows the trigger and the status shows what remains live. Read [references/lifecycle.md](references/lifecycle.md) for the state sequence, the ID table and the missing-run diagnosis.
|
|
122
|
+
|
|
123
|
+
## Report
|
|
124
|
+
|
|
125
|
+
The trigger and its source, the IDs the user needs, whether it is enabled on development and on live, whether ambient dispatch is armed and why, what the development replay proved, and what remains: an unpublished change, a live verification not yet run, or a source decision still open.
|
|
@@ -1,71 +1,59 @@
|
|
|
1
|
+
<!-- generated from .claude/skills by cli/scripts/render-skills.mjs; edit the source -->
|
|
1
2
|
# Trigger lifecycle
|
|
2
3
|
|
|
3
4
|
## State sequence
|
|
4
5
|
|
|
5
6
|
```text
|
|
6
|
-
source decision
|
|
7
|
-
-> exact node
|
|
7
|
+
source decision (basis)
|
|
8
|
+
-> exact node and event
|
|
8
9
|
-> connection
|
|
9
|
-
->
|
|
10
|
-
-> create source
|
|
11
|
-
->
|
|
12
|
-
-> capture representative event
|
|
13
|
-
->
|
|
14
|
-
->
|
|
15
|
-
-> replay captured event
|
|
16
|
-
-> publish
|
|
10
|
+
-> prop and option resolution (latest dynamicPropsId)
|
|
11
|
+
-> create source and canvas trigger (triggerId, backendTriggerId, triggerNodeId, runSubflowNodeId)
|
|
12
|
+
-> declare the flow inputs
|
|
13
|
+
-> capture a representative event, select it
|
|
14
|
+
-> bind one mapping prop per input on the run-subflow node
|
|
15
|
+
-> run the target flow on development
|
|
16
|
+
-> replay the captured event on development
|
|
17
|
+
-> audit every trigger, then authorized publish
|
|
17
18
|
-> optional live replay
|
|
18
19
|
```
|
|
19
20
|
|
|
20
|
-
Skipping capture
|
|
21
|
+
Skipping capture or selection leaves the trigger output untyped. Skipping the mapping produces a green trigger execution with empty flow inputs. Leaving ambient dispatch allowed can produce double runs after publish.
|
|
21
22
|
|
|
22
23
|
## IDs
|
|
23
24
|
|
|
24
25
|
| ID | Used by |
|
|
25
26
|
| --- | --- |
|
|
26
|
-
| Canvas `triggerId` |
|
|
27
|
-
| Numeric `backendTriggerId` |
|
|
28
|
-
| `triggerNodeId` |
|
|
29
|
-
|
|
|
27
|
+
| Canvas `triggerId` | get, rename, set-enabled, delete, test-events |
|
|
28
|
+
| Numeric `backendTriggerId` | captured events, replay (`--trigger`) |
|
|
29
|
+
| `triggerNodeId` | select-event |
|
|
30
|
+
| `runSubflowNodeId` | the mapping props, one per flow input |
|
|
31
|
+
| Captured `eventId` | event read, select-event, replay |
|
|
30
32
|
|
|
31
|
-
|
|
33
|
+
Copy them from the responses. A replaced trigger has new IDs and possibly a new webhook URL.
|
|
32
34
|
|
|
33
|
-
|
|
35
|
+
## Switches and acknowledgements
|
|
34
36
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
## Enable/disable
|
|
42
|
-
|
|
43
|
-
`cai trigger set-enabled <triggerId> --enable|--disable` sets the requested state idempotently. Pass exactly one state flag.
|
|
37
|
+
| Switch | Flags | Meaning |
|
|
38
|
+
| --- | --- | --- |
|
|
39
|
+
| Definition state | `set-enabled --enable` / `--disable` | Whether the trigger starts its flow; development edit until published |
|
|
40
|
+
| Ambient development dispatch | `test-events --allow --acknowledge-dual-run` / `--disallow` | Real events also execute the development canvas; sticky permission bit, survives disable |
|
|
41
|
+
| Replay rail | `replay --target dev` / `--target live --confirm-live` | Which version one captured event executes |
|
|
42
|
+
| Publish while armed | `workflow publish --acknowledge-dual-dispatch` | User's informed acceptance of double runs and double billing |
|
|
44
43
|
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
## Lifecycle flag families
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
cai trigger set-enabled <triggerId> --enable|--disable --json
|
|
51
|
-
cai trigger test-events <triggerId> --allow [--acknowledge-dual-run] --json
|
|
52
|
-
cai trigger test-events <triggerId> --disallow --json
|
|
53
|
-
cai trigger replay --trigger <backendTriggerId> --target dev --json
|
|
54
|
-
cai trigger replay --trigger <backendTriggerId> --target live --confirm-live --json
|
|
55
|
-
cai workflow publish --acknowledge-dual-dispatch --json
|
|
56
|
-
```
|
|
44
|
+
Each acknowledgement belongs to exactly one operation. Arming, publishing armed and live replay are three separate user decisions.
|
|
57
45
|
|
|
58
|
-
|
|
46
|
+
## Lifecycle fields
|
|
59
47
|
|
|
60
|
-
The
|
|
48
|
+
The list and get reads report `devCanvasEnabled` at the top level and, under `deployment`, `liveCanvasEnabled` (null when no live canvas exists: never published, or this trigger was added after the last publish), `inLiveVersion`, `devDispatchArmed` (enabled and allowed) and `dualDispatchLive`; get adds captured event counts and issues. The audit summarizes coverage and double-run risk before a publish and names the disarm step for each armed trigger.
|
|
61
49
|
|
|
62
|
-
##
|
|
50
|
+
## Missing-run diagnosis
|
|
63
51
|
|
|
64
|
-
1.
|
|
65
|
-
2.
|
|
66
|
-
3.
|
|
67
|
-
4.
|
|
68
|
-
5.
|
|
69
|
-
6.
|
|
52
|
+
1. The trigger list: enabled, correct flow, recoverable backend ID?
|
|
53
|
+
2. The workflow status: published, and is the live version active?
|
|
54
|
+
3. The captured events for the backend trigger ID: did ingestion capture the event?
|
|
55
|
+
4. The event read: does the payload match the selected sample?
|
|
56
|
+
5. The execution list: did an execution start?
|
|
57
|
+
6. The execution tree: where did it stop?
|
|
70
58
|
|
|
71
|
-
No captured event
|
|
59
|
+
No captured event points to the source, delivery or configuration. A captured event with no execution points to enablement, publish state or ingestion routing. An execution with empty inputs points to the mapping. Development works but live does not: compare the enabled state and the published configuration, and remember that live runs read the live data store.
|
|
@@ -1,46 +1,126 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: controllerai-workflows
|
|
3
|
-
description: Build, inspect,
|
|
3
|
+
description: Build, inspect, edit, recover, and publish Controller AI workflows and their flows. Use when a user asks to create or change an automation, a flow, or a workflow release, and for the lifecycle rules every other workflow skill relies on.
|
|
4
4
|
---
|
|
5
|
+
<!-- generated from .claude/skills by cli/scripts/render-skills.mjs; edit the source -->
|
|
5
6
|
|
|
6
|
-
#
|
|
7
|
+
# Workflows
|
|
7
8
|
|
|
8
|
-
|
|
9
|
+
## Use this when
|
|
9
10
|
|
|
10
|
-
|
|
11
|
+
- Creating a workflow, adding or repairing flows, orienting inside an existing graph, validating, checkpointing, restoring, publishing, or deleting.
|
|
12
|
+
- Another skill needs the shared lifecycle rules: which rail an edit lands on, how contracts and IDs behave, what validation and publishing require.
|
|
11
13
|
|
|
12
|
-
|
|
14
|
+
Load the narrow skill when the work reaches it: nodes, connections, props and wiring → `controllerai-node-config`; computed values and conditions → `controllerai-expressions`; Router, If/Else, loops, joins, subflows → `controllerai-flow-control`; runs and debugging → `controllerai-runs`; schedules, webhooks, app events → `controllerai-triggers`; schemas and records → `controllerai-data`; Ask AI and agent nodes → `controllerai-ai-nodes`; user-facing agents → `controllerai-agents`.
|
|
13
15
|
|
|
14
|
-
|
|
16
|
+
## How it works
|
|
15
17
|
|
|
16
|
-
|
|
18
|
+
A **workflow** groups flows, custom schemas, data collections and triggers, and its flows share one data store per environment. A **flow** is one canvas and one callable contract: typed inputs, connected nodes, typed outputs. A Return node maps values into the declared outputs; declaring an output does not fill it. Workflow, flow, node, input and output IDs are distinct identities; never swap one for another.
|
|
17
19
|
|
|
18
|
-
|
|
20
|
+
Every graph edit lands on the **development** version. Publishing creates the **live** release; a live agent that uses the workflow as a tool follows its latest live release without an agent publish, while the owner's Test conversations run the development version. Publishing never copies development records into the live store, and every environment keeps its own data.
|
|
19
21
|
|
|
20
|
-
|
|
22
|
+
Every save is a **state**. History lists states in groups and gives candidate state IDs; a restore rolls the definition back to one state and leaves records and external effects untouched. How far back history is listed and how far back a state can be restored are two separate plan limits, so a listed state is not always restorable.
|
|
21
23
|
|
|
22
|
-
|
|
23
|
-
2. Discover actions and add nodes in execution order. Configure the type or action selector before dependent props; reload props if the selector changes.
|
|
24
|
-
3. Bind expressions using current `expr_context` names. Wire the source output to the destination so it appears in `inputs`.
|
|
25
|
-
4. Use a Return node to map promised flow outputs. Merely declaring an output does not populate it.
|
|
26
|
-
5. Test a complete development path with explicit representative input. Check the returned contract and same-environment data changes.
|
|
27
|
-
6. Apply the proven pattern to additional paths. Batch independent configuration when the available tool supports it; do not combine operations whose IDs depend on earlier responses.
|
|
28
|
-
7. Layout each changed flow, validate the saved workflow, and re-read its outline.
|
|
24
|
+
Deleting a workflow tears down its deployed triggers and soft-deletes it. It is refused while any draft or live agent depends on the workflow, and nothing undeletes. The dependency map shows a workflow's agent and workflow callers and the connections it uses. Deleting a flow removes its graph, its contract and the triggers targeting it, and breaks every caller bound to it.
|
|
29
25
|
|
|
30
|
-
|
|
26
|
+
The account event feed records only supported events: connections created, workflows created, updated, deleted, published and run, agents created and published, members added. Settings changes, member removals and label edits are not in it, and a past change that is not recorded cannot be reconstructed from names or current state.
|
|
31
27
|
|
|
32
|
-
##
|
|
28
|
+
## Rules
|
|
33
29
|
|
|
34
|
-
|
|
30
|
+
1. **Before changing an existing workflow, read its outline and the affected flow**, then repair those IDs rather than creating a replacement workflow or flow. A repair that recreates loses history, triggers and callers.
|
|
31
|
+
2. **Rename contracts in place.** Deleting and recreating an input or output breaks every expression, subflow mapping and agent tool bound to it. After a rename or deletion, re-read the flow and repair the affected dependents before validating or running; a stored input-ID binding survives a rename, so the readback may show nothing to repair.
|
|
32
|
+
3. **"Store, save, log, record" without a named destination means a custom data type plus a create-record node.** A flow output alone persists nothing. When the user names a destination (a sheet, a CRM, an app, a file), write there through that integration; add a platform record only if they also want a copy kept here.
|
|
33
|
+
4. **Validate after structural edits and before publishing.** Fix every listed prop, wire, expression, type, subflow, branch and trigger error, or report each one with what it breaks. Publish refuses errors; `--acknowledge-validation-errors` is for issues the user has seen and accepted, never a shortcut. If the user forbids a repair, report and stop.
|
|
34
|
+
5. **Validation counts are status.** Do not write them into unrelated workflow properties unless the user asks for exactly that.
|
|
35
|
+
6. **Deleting a workflow needs the user's explicit intent.** A confirmation flag is not authorization. Check dependencies first; detach draft tools with `cai agent remove-tool <agentId> --tool <toolId>`, and treat a live agent's republish as its own decision.
|
|
36
|
+
7. **Layout once per changed flow.** After adds, deletes or rewires, run the flow layout as the last structural step; placement at add time only avoids overlap.
|
|
37
|
+
8. **Never weaken the request to make a test pass.** Report an unsupported capability or ask the product question. Keep deliberately armed triggers and advisory-only nodes the user chose.
|
|
38
|
+
9. **A conflict means re-read, then reapply the intent to the current graph.** Never replay a stale document or old IDs; the retried write uses the IDs the current state holds.
|
|
39
|
+
10. **Say "not recorded" and change nothing** when asked to reconstruct history the feed does not hold.
|
|
35
40
|
|
|
36
|
-
|
|
41
|
+
## Recipes
|
|
37
42
|
|
|
38
|
-
|
|
43
|
+
### Establish context
|
|
39
44
|
|
|
40
|
-
|
|
45
|
+
```bash
|
|
46
|
+
cai auth status --json
|
|
47
|
+
cai workflow list --json
|
|
48
|
+
cai use <workflowId>
|
|
49
|
+
cai workflow status --json
|
|
50
|
+
```
|
|
41
51
|
|
|
42
|
-
|
|
52
|
+
A create or `cai use` may not win the effective pin: read `selected`, `effectiveWorkflowId` and `pinSource`, and resolve as `pinSource` says (drop the command flag, use `cai use <id>`, or clear an inherited `CAI_WORKFLOW`). `cai config reset` clears stored pins only; `cai doctor` confirms the effective pin and development head.
|
|
43
53
|
|
|
44
|
-
|
|
54
|
+
### Create
|
|
45
55
|
|
|
46
|
-
|
|
56
|
+
```bash
|
|
57
|
+
cai workflow create --name "<clear outcome-oriented name>" --json
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Create with the final name. Read `flowCount` and `nextStep`: with 0 flows, create the first flow with `cai flow create --name "<name>" --json`; with one empty default flow, rename it and build in it; when either field is missing, list the flows before deciding. Add flows only for genuinely separate canvases, and stop at an empty workflow when that is what was asked. A missing projected field is not a failed create: read the full result or the exact inventory before retrying.
|
|
61
|
+
|
|
62
|
+
### Orient
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
cai workflow outline --json
|
|
66
|
+
cai workflow state --flow <flowId> --json
|
|
67
|
+
cai flow get <flowId> --json
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
The outline shows flows, contracts, graph dependencies, triggers and data inventory in one call. State is a bounded projection; pass the flow ID for node and edge identities. The flow read exposes props and expressions.
|
|
71
|
+
|
|
72
|
+
### Build
|
|
73
|
+
|
|
74
|
+
1. Translate the request into inputs, steps, outputs, trigger, integrations, failure behavior and publish intent.
|
|
75
|
+
2. Declare flow inputs and outputs before nodes whose props derive from them. Pass a human display label; use the current binding from `flow get` (`jsBinding`) or the outline (`binding`), never the diagnostic `legacyBinding`.
|
|
76
|
+
3. Add nodes in execution order and name each after the data it produces; downstream bindings are seeded from that name when wired.
|
|
77
|
+
4. Lay out each changed flow, validate, test on development, re-read status. Publish only when the user asked for a live change or authorized deployment.
|
|
78
|
+
|
|
79
|
+
### Publish
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
cai workflow status --json
|
|
83
|
+
cai trigger list --json
|
|
84
|
+
cai workflow publish --json
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Read status and every trigger first: publishing activates enabled triggers on the live release. The publish refuses validation errors and may return an approval that the user must grant.
|
|
88
|
+
|
|
89
|
+
When the publish returns an approval, the CLI polls it; if polling is interrupted, `cai approval resume <approvalId>` continues the same intent instead of publishing again.
|
|
90
|
+
|
|
91
|
+
### Checkpoint and recover
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
cai workflow save --name "<checkpoint>" --json
|
|
95
|
+
cai workflow history --json
|
|
96
|
+
cai workflow history --group <groupId> --json
|
|
97
|
+
cai workflow restore --state <stateId> --json
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
Save before a risky rewrite. Expand a group to find the state ID; restore by state, not by group.
|
|
101
|
+
|
|
102
|
+
### Delete
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
cai deps --json
|
|
106
|
+
cai workflow delete <workflowId> --yes
|
|
107
|
+
```
|
|
108
|
+
`cai deps --account` maps the whole account. The `--force` flag is deprecated and inert.
|
|
109
|
+
|
|
110
|
+
## Verify
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
cai workflow outline --json
|
|
114
|
+
cai workflow validate --json
|
|
115
|
+
cai workflow status --json
|
|
116
|
+
cai flow get <flowId> --json
|
|
117
|
+
cai run flow <flowId> --inputs <values.json> --json
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Evidence that a build works: validation reports zero errors, or each remaining error is reported with its effect; required connections and props are complete; expressions resolve to the expected values, with intentional empties explained; the expected branch and error paths ran where practical; the flow outputs contain the promised values; the development or live state matches the request; the final outline matches the request, with only your own abandoned scratch objects removed. A checkpoint or a rename needs its readback, not a run. Once the requested blockers are fixed and each changed path ran once, stop; warnings alone do not justify a redesign.
|
|
121
|
+
|
|
122
|
+
## Report
|
|
123
|
+
|
|
124
|
+
What was built, what ran and what it returned, whether it is published, and any connection or product decision still pending. Share returned product links only; never guess one.
|
|
125
|
+
|
|
126
|
+
Read [references/command-map.md](references/command-map.md) for the command families by domain when a task spans several areas.
|