@culvii/cli 0.0.7 → 0.0.9
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/COMMANDS.md +5 -5
- package/README.md +15 -6
- package/USAGE.md +11 -10
- package/dist/DeployView-D4UEXMDJ.js +2 -0
- package/dist/DevView-GPKSSOLA.js +2 -0
- package/dist/EnvView-3ZURMIZS.js +2 -0
- package/dist/{HelpView-YLCEPIFY.js → HelpView-PELQJJQQ.js} +1 -1
- package/dist/WhoamiView-TKSYSHQ2.js +2 -0
- package/dist/{WorkspaceView-RNFALIPM.js → WorkspaceView-ID7ZMBHV.js} +1 -1
- package/dist/{chunk-IRZMWFC3.js → chunk-KM7ZWOEG.js} +1 -1
- package/dist/index.js +31 -681
- package/dist/lib/evaluator.js +2 -2
- package/dist/login-3OMS75QL.js +39 -0
- package/dist/{logout-TDZA462P.js → logout-ZYTERDYA.js} +1 -1
- package/dist/skill-bundle-Z4FQO3CQ.js +2553 -0
- package/package.json +9 -5
- package/skills/culvii/.culvii-skill.json +90 -0
- package/skills/culvii/SKILL.md +104 -0
- package/skills/culvii/agents/openai.yaml +4 -0
- package/skills/culvii/examples/agent-workflow.culvii.ts +47 -0
- package/skills/culvii/examples/binary-document-workflow.culvii.ts +80 -0
- package/skills/culvii/examples/complete-workflow.culvii.ts +81 -0
- package/skills/culvii/examples/custom-output-surface.culvii.ts +69 -0
- package/skills/culvii/examples/custom-wait-surface.culvii.ts +90 -0
- package/skills/culvii/examples/human-in-the-loop-workflow.culvii.ts +125 -0
- package/skills/culvii/examples/integration-agent-workflow.culvii.ts +101 -0
- package/skills/culvii/examples/multi-agent-workflow-tools.culvii.ts +157 -0
- package/skills/culvii/examples/nested-agent-workflow.culvii.ts +108 -0
- package/skills/culvii/examples/output-surface.culvii.ts +45 -0
- package/skills/culvii/examples/wait-surface.culvii.ts +24 -0
- package/skills/culvii/references/agents.md +77 -0
- package/skills/culvii/references/authoring-files.md +21 -0
- package/skills/culvii/references/cli-guide.md +22 -0
- package/skills/culvii/references/cli-reference.md +217 -0
- package/skills/culvii/references/feedback-cycle.md +43 -0
- package/skills/culvii/references/integrations.md +13 -0
- package/skills/culvii/references/kit-api.md +35 -0
- package/skills/culvii/references/node-argocd.md +44 -0
- package/skills/culvii/references/node-clickup-doc.md +38 -0
- package/skills/culvii/references/node-clickup-ticket.md +47 -0
- package/skills/culvii/references/node-core-agent.md +27 -0
- package/skills/culvii/references/node-core-browser-automation.md +53 -0
- package/skills/culvii/references/node-core-code.md +28 -0
- package/skills/culvii/references/node-core-http.md +42 -0
- package/skills/culvii/references/node-core-if.md +26 -0
- package/skills/culvii/references/node-core-jwt.md +31 -0
- package/skills/culvii/references/node-core-loop-break.md +26 -0
- package/skills/culvii/references/node-core-loop-continue.md +26 -0
- package/skills/culvii/references/node-core-loop-output.md +24 -0
- package/skills/culvii/references/node-core-loop.md +25 -0
- package/skills/culvii/references/node-core-merge.md +23 -0
- package/skills/culvii/references/node-core-set.md +24 -0
- package/skills/culvii/references/node-core-switch.md +24 -0
- package/skills/culvii/references/node-cost-explorer.md +45 -0
- package/skills/culvii/references/node-cron-trigger.md +25 -0
- package/skills/culvii/references/node-elasticsearch.md +39 -0
- package/skills/culvii/references/node-github-poll-trigger.md +31 -0
- package/skills/culvii/references/node-github-webhook-trigger.md +27 -0
- package/skills/culvii/references/node-github.md +251 -0
- package/skills/culvii/references/node-gmail-trigger.md +44 -0
- package/skills/culvii/references/node-gmail.md +57 -0
- package/skills/culvii/references/node-google-calendar.md +51 -0
- package/skills/culvii/references/node-google-docs.md +46 -0
- package/skills/culvii/references/node-grafana-dashboard.md +38 -0
- package/skills/culvii/references/node-grafana-data-source.md +42 -0
- package/skills/culvii/references/node-grafana-query.md +34 -0
- package/skills/culvii/references/node-hibp-list-domains.md +27 -0
- package/skills/culvii/references/node-hibp-stealer-logs.md +30 -0
- package/skills/culvii/references/node-kubernetes.md +51 -0
- package/skills/culvii/references/node-manual-trigger.md +24 -0
- package/skills/culvii/references/node-microsoft-outlook-trigger.md +41 -0
- package/skills/culvii/references/node-microsoft-outlook.md +56 -0
- package/skills/culvii/references/node-microsoft-sharepoint.md +40 -0
- package/skills/culvii/references/node-onionsearch.md +27 -0
- package/skills/culvii/references/node-prometheus.md +40 -0
- package/skills/culvii/references/node-s3.md +40 -0
- package/skills/culvii/references/node-slack-events-trigger.md +37 -0
- package/skills/culvii/references/node-slack-interactions-trigger.md +28 -0
- package/skills/culvii/references/node-slack-trigger.md +40 -0
- package/skills/culvii/references/node-slack.md +162 -0
- package/skills/culvii/references/node-supabase.md +61 -0
- package/skills/culvii/references/node-twilio.md +39 -0
- package/skills/culvii/references/node-wait-timer.md +24 -0
- package/skills/culvii/references/node-webhook-trigger.md +24 -0
- package/skills/culvii/references/nodes-index.md +51 -0
- package/skills/culvii/references/runtime-values.md +36 -0
- package/skills/culvii/references/surface-authoring.md +38 -0
- package/skills/culvii/references/surface-display.md +390 -0
- package/skills/culvii/references/surface-feedback.md +38 -0
- package/skills/culvii/references/surface-input-actions.md +143 -0
- package/skills/culvii/references/surface-layout.md +97 -0
- package/skills/culvii/references/validation.md +18 -0
- package/skills/culvii/references/workflows.md +30 -0
- package/dist/DeployView-GEJNL26A.js +0 -2
- package/dist/DevView-SOPAMSZ4.js +0 -2
- package/dist/EnvView-MCZC2NBO.js +0 -2
- package/dist/WhoamiView-67HV2L5J.js +0 -2
- package/dist/chunk-MPKGJC7N.js +0 -2
- package/dist/login-G5QUR55L.js +0 -36
- /package/dist/{chunk-5NBKYMD7.js → chunk-56C3DFV2.js} +0 -0
- /package/dist/{chunk-JFIFRAAR.js → chunk-RS5GDTRN.js} +0 -0
|
@@ -0,0 +1,217 @@
|
|
|
1
|
+
# CLI reference
|
|
2
|
+
|
|
3
|
+
Generated from the registered Commander command tree. Disabled and unregistered commands are excluded.
|
|
4
|
+
|
|
5
|
+
## `culvii`
|
|
6
|
+
|
|
7
|
+
Culvii CLI
|
|
8
|
+
|
|
9
|
+
Options:
|
|
10
|
+
|
|
11
|
+
- `--debug` — Enable debug logging to ~/.culvii/logs/cli.log
|
|
12
|
+
- `-V, --version` — output the version number
|
|
13
|
+
|
|
14
|
+
## `culvii auth`
|
|
15
|
+
|
|
16
|
+
Authentication commands
|
|
17
|
+
|
|
18
|
+
## `culvii auth login`
|
|
19
|
+
|
|
20
|
+
Login to Culvii
|
|
21
|
+
|
|
22
|
+
## `culvii auth logout`
|
|
23
|
+
|
|
24
|
+
Logout of Culvii
|
|
25
|
+
|
|
26
|
+
## `culvii deploy`
|
|
27
|
+
|
|
28
|
+
Deploy an agent
|
|
29
|
+
|
|
30
|
+
Options:
|
|
31
|
+
|
|
32
|
+
- `--env <env>` (required) — Environment (sandbox or prod)
|
|
33
|
+
- `--workspace-slug <slug>` — Target workspace slug (overrides config)
|
|
34
|
+
|
|
35
|
+
## `culvii dev`
|
|
36
|
+
|
|
37
|
+
Start the development server and file watcher
|
|
38
|
+
|
|
39
|
+
## `culvii env [environment]`
|
|
40
|
+
|
|
41
|
+
Show or switch the active environment (dev, sandbox, prod)
|
|
42
|
+
|
|
43
|
+
## `culvii execution`
|
|
44
|
+
|
|
45
|
+
Inspect workflow executions
|
|
46
|
+
|
|
47
|
+
Options:
|
|
48
|
+
|
|
49
|
+
- `--env <env>` — Target environment (dev, sandbox, or prod)
|
|
50
|
+
|
|
51
|
+
## `culvii execution get <execution-id>`
|
|
52
|
+
|
|
53
|
+
Get execution details, step outputs, and errors
|
|
54
|
+
|
|
55
|
+
Options:
|
|
56
|
+
|
|
57
|
+
- `--json` — Print machine-readable JSON
|
|
58
|
+
|
|
59
|
+
## `culvii execution list`
|
|
60
|
+
|
|
61
|
+
List workspace executions
|
|
62
|
+
|
|
63
|
+
Options:
|
|
64
|
+
|
|
65
|
+
- `--json` — Print machine-readable JSON
|
|
66
|
+
- `--limit <limit>` — Results per page
|
|
67
|
+
- `--page <page>` — Page number
|
|
68
|
+
- `--status <status>` — Filter by execution status
|
|
69
|
+
- `--trigger <trigger>` — Filter by trigger type
|
|
70
|
+
- `--workflow <workflow>` — Filter by workflow reference key or ID
|
|
71
|
+
|
|
72
|
+
## `culvii init [project-name]`
|
|
73
|
+
|
|
74
|
+
Scaffold a new Culvii project with working agent and workflow files
|
|
75
|
+
|
|
76
|
+
Options:
|
|
77
|
+
|
|
78
|
+
- `--here` — Scaffold into the current directory instead of a named subdirectory
|
|
79
|
+
- `--provider <provider>` — Model provider: openai | anthropic | gemini | google-vertex
|
|
80
|
+
- `--template <template>` — Template: agent-only | agent-workflow | agent-workflow-tool | multi-agent
|
|
81
|
+
- `-y, --yes` — Accept all defaults non-interactively
|
|
82
|
+
|
|
83
|
+
## `culvii integration`
|
|
84
|
+
|
|
85
|
+
List and manage Culvii integrations
|
|
86
|
+
|
|
87
|
+
Options:
|
|
88
|
+
|
|
89
|
+
- `--env <env>` — Target environment (dev, sandbox, or prod)
|
|
90
|
+
|
|
91
|
+
## `culvii integration list`
|
|
92
|
+
|
|
93
|
+
List available integration credentials and their scopes
|
|
94
|
+
|
|
95
|
+
Options:
|
|
96
|
+
|
|
97
|
+
- `--json` — Print machine-readable JSON
|
|
98
|
+
|
|
99
|
+
## `culvii login`
|
|
100
|
+
|
|
101
|
+
Login to Culvii
|
|
102
|
+
|
|
103
|
+
## `culvii logout`
|
|
104
|
+
|
|
105
|
+
Logout of Culvii
|
|
106
|
+
|
|
107
|
+
## `culvii rename <old-slug> <new-slug>`
|
|
108
|
+
|
|
109
|
+
Rename a resource
|
|
110
|
+
|
|
111
|
+
Options:
|
|
112
|
+
|
|
113
|
+
- `--env <env>` — Target environment (sandbox or prod)
|
|
114
|
+
- `--resource-type <type>` (required) — Type of resource (agent)
|
|
115
|
+
- `--workspace-slug <slug>` — Target workspace slug (overrides config)
|
|
116
|
+
|
|
117
|
+
## `culvii skill`
|
|
118
|
+
|
|
119
|
+
Manage AI agent skills
|
|
120
|
+
|
|
121
|
+
## `culvii skill install`
|
|
122
|
+
|
|
123
|
+
Install the Culvii authoring skill bundle for AI agents
|
|
124
|
+
|
|
125
|
+
Options:
|
|
126
|
+
|
|
127
|
+
- `--agent <agent>` — Specify agent (claude|cursor|windsurf|github|opencode|gemini|kiro|codex|agents)
|
|
128
|
+
- `--force` — Replace an existing unmanaged Culvii skill directory
|
|
129
|
+
- `--global` — Install globally instead of in the current project
|
|
130
|
+
|
|
131
|
+
## `culvii surface`
|
|
132
|
+
|
|
133
|
+
Surface authoring and review commands
|
|
134
|
+
|
|
135
|
+
Options:
|
|
136
|
+
|
|
137
|
+
- `--env <env>` — Target environment (dev, sandbox, or prod)
|
|
138
|
+
|
|
139
|
+
## `culvii surface review`
|
|
140
|
+
|
|
141
|
+
Review custom runtime surfaces
|
|
142
|
+
|
|
143
|
+
## `culvii surface review create`
|
|
144
|
+
|
|
145
|
+
Create a browser review for selected execution surfaces
|
|
146
|
+
|
|
147
|
+
Options:
|
|
148
|
+
|
|
149
|
+
- `--file <path>` (required) — JSON file with { items: [{ executionId, nodeId }] }
|
|
150
|
+
- `--json` — Print machine-readable JSON
|
|
151
|
+
|
|
152
|
+
## `culvii surface review get <review-id>`
|
|
153
|
+
|
|
154
|
+
Get selected surfaces and the user feedback collected so far
|
|
155
|
+
|
|
156
|
+
Options:
|
|
157
|
+
|
|
158
|
+
- `--json` — Print machine-readable JSON
|
|
159
|
+
|
|
160
|
+
## `culvii surface review open <review-id>`
|
|
161
|
+
|
|
162
|
+
Open a surface review in the Culvii Console
|
|
163
|
+
|
|
164
|
+
## `culvii switch [tenant-slug]`
|
|
165
|
+
|
|
166
|
+
Switch the active tenant context
|
|
167
|
+
|
|
168
|
+
## `culvii whoami`
|
|
169
|
+
|
|
170
|
+
Show current authenticated user context
|
|
171
|
+
|
|
172
|
+
Options:
|
|
173
|
+
|
|
174
|
+
- `--json` — Output as JSON
|
|
175
|
+
|
|
176
|
+
## `culvii workflow`
|
|
177
|
+
|
|
178
|
+
Workflow execution commands
|
|
179
|
+
|
|
180
|
+
Options:
|
|
181
|
+
|
|
182
|
+
- `--env <env>` — Target environment (dev, sandbox, or prod)
|
|
183
|
+
|
|
184
|
+
## `culvii workflow run <workflow>`
|
|
185
|
+
|
|
186
|
+
Start a workflow execution
|
|
187
|
+
|
|
188
|
+
Options:
|
|
189
|
+
|
|
190
|
+
- `--json` — Print machine-readable JSON
|
|
191
|
+
- `--mocks-file <path>` — JSON object mapping node IDs to mock outputs
|
|
192
|
+
- `--payload <json>` — Trigger payload as JSON
|
|
193
|
+
- `--payload-file <path>` — Read trigger payload from a JSON file
|
|
194
|
+
- `--trigger <node-name>` (required) — Trigger node name
|
|
195
|
+
|
|
196
|
+
## `culvii workspace`
|
|
197
|
+
|
|
198
|
+
Workspace commands
|
|
199
|
+
|
|
200
|
+
Options:
|
|
201
|
+
|
|
202
|
+
- `--env <env>` — Target environment (sandbox or prod)
|
|
203
|
+
|
|
204
|
+
## `culvii workspace create`
|
|
205
|
+
|
|
206
|
+
Create a new workspace
|
|
207
|
+
|
|
208
|
+
Options:
|
|
209
|
+
|
|
210
|
+
- `--name <name>` (required) — Workspace name
|
|
211
|
+
- `--slug <slug>` (required) — Workspace slug
|
|
212
|
+
|
|
213
|
+
## `culvii workspace list`
|
|
214
|
+
|
|
215
|
+
List workspaces
|
|
216
|
+
|
|
217
|
+
Further reading: [`culvii dev`](https://culvii.com/docs/cli/dev/) and [`culvii deploy`](https://culvii.com/docs/cli/deploy/).
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# Workflow feedback cycle
|
|
2
|
+
|
|
3
|
+
Use this only after `culvii dev` has validated and synced the requested draft resources.
|
|
4
|
+
|
|
5
|
+
1. Keep the tracked `culvii dev` process running.
|
|
6
|
+
2. Execute feedback only through a `manualTrigger`. If the selected authored trigger is cron, webhook, or polling, first snapshot its exact type, params, credentials, and other trigger-specific fields. Temporarily change that same step to `manualTrigger` while preserving its `id`, `name`, connections, and attached surfaces; remove incompatible trigger-only fields until restoration. Let the active `culvii dev` watcher validate and sync the temporary graph before continuing.
|
|
7
|
+
3. Create a JSON payload matching the real runtime trigger's expected output shape. This representative payload becomes the mocked manual-trigger output automatically and supplies both downstream workflow data and surface preview data. Never mock or invoke the cron, webhook, or polling implementation itself.
|
|
8
|
+
4. For every node reachable from the manual trigger whose generated node reference says `Feedback mock: required`, create a mock output keyed by the node's authored `id`. Do not include cron, webhook, or polling triggers in the mock file. Do not mock `core.agent`; agents must execute through their workflow node.
|
|
9
|
+
5. Start the draft workflow with `culvii workflow run <workflow-reference-key> --trigger <manual-node-name> --payload-file <path> --mocks-file <path> --json`.
|
|
10
|
+
6. Fetch `culvii execution get <execution-id> --json` until its status is `success` or `failed`. This status polling is not a workflow wait and must not resume paused nodes.
|
|
11
|
+
7. On failure, inspect the execution error and the failing step's input/output ports. Fix the authored resource or mock fixture, allow `culvii dev` to resync, and rerun. Stop after three failed attempts and report the remaining error unless the user asks to continue.
|
|
12
|
+
8. On success, inspect the final and intermediate step outputs for the requested behavior. If the workflow has custom candidate surfaces, use these outputs to complete [surface review](surface-feedback.md#validate-execute-and-review). Return to the development lifecycle only after all surface decisions are resolved; keep `culvii dev` running until then.
|
|
13
|
+
9. In success, failure, cancellation, and blocker cleanup, restore the temporarily converted trigger exactly from the snapshot. Wait for `culvii dev` to validate and sync the restored authored graph before stopping the dev process. Do not modify an originally authored manual trigger.
|
|
14
|
+
|
|
15
|
+
The platform applies these execution-only overrides; the agent must not write them into the authored files:
|
|
16
|
+
|
|
17
|
+
- Every node receives `pauseAfterExecution: false`.
|
|
18
|
+
- `core.agent` receives `autoCloseSession: true`.
|
|
19
|
+
- Agents outside the workflow are not executed.
|
|
20
|
+
- Surfaces do not control execution progress. Their visual approval uses sanitized execution output but does not change workflow execution.
|
|
21
|
+
|
|
22
|
+
## Mock file
|
|
23
|
+
|
|
24
|
+
The file is a JSON object keyed by workflow node ID. An object produces one output item; an array produces multiple items on the first output. Use `batches` only when a node needs multiple output indexes.
|
|
25
|
+
|
|
26
|
+
```json
|
|
27
|
+
{
|
|
28
|
+
"gmail-send": { "id": "mock-message-1", "threadId": "mock-thread-1" },
|
|
29
|
+
"outlook-read": [
|
|
30
|
+
{ "id": "mail-1", "subject": "Urgent request", "from": "person@example.com" }
|
|
31
|
+
],
|
|
32
|
+
"multi-output-node": {
|
|
33
|
+
"batches": [
|
|
34
|
+
[{ "matched": true }],
|
|
35
|
+
[{ "matched": false }]
|
|
36
|
+
]
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
In mock mode, the trigger payload becomes the selected manual trigger's output. Feedback execution rejects non-manual triggers. A node marked as requiring a feedback mock fails safely when its mock is missing instead of executing. Nodes not marked this way, including core workflow logic and workflow-contained agents, execute normally.
|
|
42
|
+
|
|
43
|
+
Use `culvii execution list --workflow <workflow> --page <n> --limit <n> --json` to find earlier runs. Use [cli-reference.md](cli-reference.md) for the current generated flags.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Integration selection
|
|
2
|
+
|
|
3
|
+
Use this flow whenever an agent model or workflow node requires a Culvii credential ID.
|
|
4
|
+
|
|
5
|
+
1. After authentication and tenant selection, run `culvii integration list --json` in the user's project.
|
|
6
|
+
2. Use only a connected integration whose provider, platform scope, and OAuth scopes cover the requested operation. The command returns each usable `credentialId` and the active tenant/environment's `addUrl`.
|
|
7
|
+
3. If exactly one integration matches, use its `credentialId` directly in the authored resource without asking the user to copy it.
|
|
8
|
+
4. If several match, ask one in-run selectable question. Label each option with its integration name, provider, and scope; retain the option-to-`credentialId` mapping internally.
|
|
9
|
+
5. If none match, show the exact `addUrl` returned by the command on its own line as `🟨 **Integration URL:** \`<addUrl>\`` and ask the user to add or connect the integration. The yellow marker is portable; do not emit raw ANSI color codes because structured question dialogs control their own text colors. Keep the current agent run open. After the user confirms completion, rerun `culvii integration list --json` and continue from its real output.
|
|
10
|
+
|
|
11
|
+
Never ask the user to find, copy, or paste a credential ID. Never invent one. A tenant-scoped integration applies tenant-wide; an environment-scoped integration applies only to its environment; a workspace-scoped integration applies only to the listed workspace IDs. Treat `connected: false` or insufficient OAuth scopes as unusable and explain what must be connected or authorized at the displayed URL.
|
|
12
|
+
|
|
13
|
+
Users can run `culvii integration list` themselves for a readable table or add `--json` for machine-readable output. See [the generated CLI reference](cli-reference.md) for current flags.
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Kit API
|
|
2
|
+
|
|
3
|
+
Generated from the public `@culvii/kit` source exports. Import authoring APIs only from `@culvii/kit`.
|
|
4
|
+
|
|
5
|
+
## Key signatures
|
|
6
|
+
|
|
7
|
+
- `new MultiAgentEngine(primaryConfig: PrimaryAgentConfig)`
|
|
8
|
+
- `createAgentModelConfigFromRef(modelRef, credentialId, options?)`
|
|
9
|
+
- `defineWorkflowTool({ name, description, workflowId, triggerNodeName?, inputSchema? })`
|
|
10
|
+
- `new Workflow({ id, name, active?, steps? })`
|
|
11
|
+
- `new Step({ id?, name, type, params?, credentials?, disabled?, onError?, ui? })`
|
|
12
|
+
- `step.connectTo(nextStep, { fromPort?, fromOutputIndex?, toInputIndex? })`
|
|
13
|
+
- `new Surface({ id, name, description?, slot, definition })`
|
|
14
|
+
|
|
15
|
+
## Agents
|
|
16
|
+
|
|
17
|
+
`AgentBaseConfig`, `AgentIntegrationConfig`, `AgentMetadata`, `AgentModel`, `AgentModelConfig`, `AgentModelConfigOptions`, `AgentModelRef`, `AgentPermissions`, `AgentRole`, `AgentRuntimeDetails`, `BuiltInModelProvider`, `MultiAgentEngine`, `PrimaryAgentConfig`, `SANDBOX_TOOL_NAMES`, `SandboxToolName`, `SandboxToolPermission`, `SecondaryAgentConfig`, `SecondaryAgentMetadata`, `Tool`, `WorkflowToolConfig`, `createAgentModelConfigFromRef`, `defineWorkflowTool`, `parseAgentModelRef`
|
|
18
|
+
|
|
19
|
+
## Development registry
|
|
20
|
+
|
|
21
|
+
`DevRegistry`
|
|
22
|
+
|
|
23
|
+
## Shared types
|
|
24
|
+
|
|
25
|
+
`CulviiConfig`, `CulviiRuntime`, `DIDDocument`, `Guard`, `HealthReport`, `HookContext`, `IdentityConfig`, `IdentityRef`, `MaybePromise`, `MemoryConfig`, `MemoryType`, `Message`, `ObserveConfig`, `Permission`, `Plan`, `Policy`, `RetryConfig`, `SandboxConfig`, `Schema`, `Skill`, `StepTrace`, `Tool`, `ToolCallEvent`, `ToolResultEvent`, `Usage`
|
|
26
|
+
|
|
27
|
+
## Surfaces
|
|
28
|
+
|
|
29
|
+
`BinaryDescriptor`, `DefaultSurfaceSelection`, `ExecutionUiBinaryNodeValues`, `ExecutionUiDataModel`, `ExecutionUiNodeValues`, `ExecutionUiSurfaceEntry`, `ExecutionUiSurfaceMap`, `NodeSurfaceSlot`, `RuntimeSurface`, `RuntimeSurfaceAction`, `RuntimeSurfaceComponent`, `SerializedNodeUiConfig`, `SerializedSurface`, `SerializedSurfaceSelection`, `Surface`, `SurfaceAction`, `SurfaceBinding`, `SurfaceComponent`, `SurfaceConfig`, `SurfaceFormField`, `SurfaceReference`, `UISurfaceDefinition`, `UIValue`, `isSurface`
|
|
30
|
+
|
|
31
|
+
## Workflows and steps
|
|
32
|
+
|
|
33
|
+
`ConnectStepOptions`, `CredentialedNodeType`, `LoopBodyBuilder`, `NodeExpression`, `NodeParams`, `NodeParamsBase`, `NodeType`, `NodeTypeInput`, `NodeTypeParamsMap`, `NodeUiConfig`, `RegisteredNodeType`, `Resolvable`, `SerializedWorkflow`, `SerializedWorkflowStep`, `Step`, `StepCredentials`, `StepSurfaceSelection`, `Workflow`, `WorkflowConfig`, `WorkflowLoopConfig`, `WorkflowRuntimeConnection`, `WorkflowRuntimeConnections`, `WorkflowRuntimeNode`, `WorkflowRuntimeShape`, `WorkflowStepConfig`, `WorkflowStepConnection`
|
|
34
|
+
|
|
35
|
+
Further reading: [Workflow API](https://culvii.com/docs/sdk-reference/api-reference/workflow-api/), [Multi-Agent API](https://culvii.com/docs/sdk-reference/api-reference/multi-agent-api/), and [Authentication](https://culvii.com/docs/sdk-reference/guides/authentication/).
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# argocd
|
|
2
|
+
|
|
3
|
+
- Type ID: `argocd`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`; `name` must be one of: `argocd`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `resource`: options; required
|
|
13
|
+
- Values: `application`, `project`
|
|
14
|
+
- `operation`: options; required; when resource=application
|
|
15
|
+
- Values: `getApplication`, `syncApplication`, `listApplications`, `getResourceTree`
|
|
16
|
+
- `operation`: options; required; when resource=project
|
|
17
|
+
- Values: `listProjects`
|
|
18
|
+
- `applicationName`: string; required; when resource=application, operation=getApplication
|
|
19
|
+
- `refresh`: options; optional; when resource=application, operation=getApplication
|
|
20
|
+
- Values: ``, `normal`, `hard`
|
|
21
|
+
- `applicationName`: string; required; when resource=application, operation=syncApplication
|
|
22
|
+
- `revision`: string; optional; when resource=application, operation=syncApplication
|
|
23
|
+
- `prune`: boolean; optional; when resource=application, operation=syncApplication
|
|
24
|
+
- `dryRun`: boolean; optional; when resource=application, operation=syncApplication
|
|
25
|
+
- `strategy`: options; optional; when resource=application, operation=syncApplication
|
|
26
|
+
- Values: `hook`, `apply`
|
|
27
|
+
- `force`: boolean; optional; when resource=application, operation=syncApplication, strategy=apply
|
|
28
|
+
- `project`: string; optional; when resource=application, operation=listApplications
|
|
29
|
+
- `applicationName`: string; required; when resource=application, operation=getResourceTree
|
|
30
|
+
- `pauseAfterExecution`: boolean; optional
|
|
31
|
+
|
|
32
|
+
## Example
|
|
33
|
+
|
|
34
|
+
```ts
|
|
35
|
+
new Step({
|
|
36
|
+
id: 'argocd',
|
|
37
|
+
name: 'argocd',
|
|
38
|
+
type: 'argocd',
|
|
39
|
+
credentials: { name: 'argocd', id: 'credential-id' },
|
|
40
|
+
params: { /* use the required props and conditional values above */ },
|
|
41
|
+
});
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Further reading: [Culvii argocd node](https://culvii.com/docs/nodes/argocd/).
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# clickupDoc
|
|
2
|
+
|
|
3
|
+
- Type ID: `clickupDoc`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`; `name` must be one of: `clickup`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `resource`: options; required
|
|
13
|
+
- Values: `doc`
|
|
14
|
+
- `operation`: options; required; when resource=doc
|
|
15
|
+
- Values: `create`, `read`
|
|
16
|
+
- `workspaceId`: string; required; when resource=doc, operation=create
|
|
17
|
+
- `name`: string; required; when resource=doc, operation=create
|
|
18
|
+
- `parentType`: options; required; when resource=doc, operation=create
|
|
19
|
+
- Values: `12`, `4`, `5`, `6`
|
|
20
|
+
- `parentId`: string; optional; when resource=doc, operation=create
|
|
21
|
+
- `content`: string; optional; when resource=doc, operation=create
|
|
22
|
+
- `workspaceId`: string; required; when resource=doc, operation=read
|
|
23
|
+
- `docId`: string; required; when resource=doc, operation=read
|
|
24
|
+
- `pauseAfterExecution`: boolean; optional
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```ts
|
|
29
|
+
new Step({
|
|
30
|
+
id: 'clickup-doc',
|
|
31
|
+
name: 'clickupDoc',
|
|
32
|
+
type: 'clickupDoc',
|
|
33
|
+
credentials: { name: 'clickup', id: 'credential-id' },
|
|
34
|
+
params: { /* use the required props and conditional values above */ },
|
|
35
|
+
});
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Further reading: [Culvii clickupDoc node](https://culvii.com/docs/nodes/clickup-doc/).
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# clickupTicket
|
|
2
|
+
|
|
3
|
+
- Type ID: `clickupTicket`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: required as `credentials: { name, id }`; `name` must be one of: `clickup`
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
Resolve the credential through [integration selection](integrations.md); never ask the user to copy a credential ID.
|
|
9
|
+
|
|
10
|
+
## Props
|
|
11
|
+
|
|
12
|
+
- `resource`: options; required
|
|
13
|
+
- Values: `ticket`
|
|
14
|
+
- `operation`: options; required; when resource=ticket
|
|
15
|
+
- Values: `create`, `update`, `updateStatus`, `updateDescription`
|
|
16
|
+
- `listId`: string; required; when resource=ticket, operation=create
|
|
17
|
+
- `name`: string; required; when resource=ticket, operation=create
|
|
18
|
+
- `description`: string; optional; when resource=ticket, operation=create
|
|
19
|
+
- `status`: string; optional; when resource=ticket, operation=create
|
|
20
|
+
- `assignees`: string; optional; when resource=ticket, operation=create
|
|
21
|
+
- `priority`: options; optional; when resource=ticket, operation=create
|
|
22
|
+
- Values: ``, `1`, `2`, `3`, `4`
|
|
23
|
+
- `taskId`: string; required; when resource=ticket, operation=update
|
|
24
|
+
- `name`: string; optional; when resource=ticket, operation=update
|
|
25
|
+
- `description`: string; optional; when resource=ticket, operation=update
|
|
26
|
+
- `status`: string; optional; when resource=ticket, operation=update
|
|
27
|
+
- `priority`: options; optional; when resource=ticket, operation=update
|
|
28
|
+
- Values: ``, `1`, `2`, `3`, `4`
|
|
29
|
+
- `taskId`: string; required; when resource=ticket, operation=updateStatus
|
|
30
|
+
- `status`: string; required; when resource=ticket, operation=updateStatus
|
|
31
|
+
- `taskId`: string; required; when resource=ticket, operation=updateDescription
|
|
32
|
+
- `description`: string; required; when resource=ticket, operation=updateDescription
|
|
33
|
+
- `pauseAfterExecution`: boolean; optional
|
|
34
|
+
|
|
35
|
+
## Example
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
new Step({
|
|
39
|
+
id: 'clickup-ticket',
|
|
40
|
+
name: 'clickupTicket',
|
|
41
|
+
type: 'clickupTicket',
|
|
42
|
+
credentials: { name: 'clickup', id: 'credential-id' },
|
|
43
|
+
params: { /* use the required props and conditional values above */ },
|
|
44
|
+
});
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Further reading: [Culvii clickupTicket node](https://culvii.com/docs/nodes/clickup-ticket/).
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# core.agent
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.agent`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `agentReferenceKey`: string; required
|
|
11
|
+
- `prompt`: string; required
|
|
12
|
+
- `autoCloseSession`: boolean; optional
|
|
13
|
+
- `outputFormat`: json; optional
|
|
14
|
+
- `pauseAfterExecution`: boolean; optional
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ts
|
|
19
|
+
new Step({
|
|
20
|
+
id: 'core-agent',
|
|
21
|
+
name: 'core.agent',
|
|
22
|
+
type: 'core.agent',
|
|
23
|
+
params: { /* use the required props and conditional values above */ },
|
|
24
|
+
});
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Further reading: [Culvii core.agent node](https://culvii.com/docs/nodes/core/agent/).
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# core.browserAutomation
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.browserAutomation`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `url`: string; required
|
|
11
|
+
- `timeoutMs`: number; optional
|
|
12
|
+
- `includeHtml`: boolean; optional
|
|
13
|
+
- `auth`: object; required
|
|
14
|
+
- `type`: options; required
|
|
15
|
+
- Values: `none`, `form`
|
|
16
|
+
- `loginUrl`: string; optional; when type=form
|
|
17
|
+
- `usernameSelector`: string; optional; when type=form
|
|
18
|
+
- `passwordSelector`: string; optional; when type=form
|
|
19
|
+
- `submitSelector`: string; optional; when type=form
|
|
20
|
+
- `otpSelector`: string; optional; when type=form
|
|
21
|
+
- `otpSubmitSelector`: string; optional; when type=form
|
|
22
|
+
- `useTotp`: boolean; optional; when type=form
|
|
23
|
+
- `steps`: array; optional
|
|
24
|
+
- `step`: object; optional
|
|
25
|
+
- `type`: options; optional
|
|
26
|
+
- Values: `goto`, `fill`, `click`, `waitForSelector`, `waitForTimeout`, `extract`
|
|
27
|
+
- `url`: string; optional; when type=goto
|
|
28
|
+
- `waitUntil`: options; optional; when type=goto
|
|
29
|
+
- Values: `load`, `domcontentloaded`, `networkidle`
|
|
30
|
+
- `selector`: string; optional; when type=fill|click|waitForSelector
|
|
31
|
+
- `value`: string; optional; when type=fill
|
|
32
|
+
- `timeoutMs`: number; optional; when type=waitForSelector|waitForTimeout
|
|
33
|
+
- `selectors`: array; optional; when type=extract
|
|
34
|
+
- `selectorRule`: object; optional
|
|
35
|
+
- `key`: string; optional
|
|
36
|
+
- `selector`: string; optional
|
|
37
|
+
- `type`: options; optional
|
|
38
|
+
- Values: `text`, `texts`, `attr`, `attrs`
|
|
39
|
+
- `attrName`: string; optional; when type=attr|attrs
|
|
40
|
+
- `pauseAfterExecution`: boolean; optional
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
```ts
|
|
45
|
+
new Step({
|
|
46
|
+
id: 'core-browser-automation',
|
|
47
|
+
name: 'core.browserAutomation',
|
|
48
|
+
type: 'core.browserAutomation',
|
|
49
|
+
params: { /* use the required props and conditional values above */ },
|
|
50
|
+
});
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Further reading: [Culvii core.browserAutomation node](https://culvii.com/docs/nodes/core/browser-automation/).
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# core.code
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.code`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `code`: string; required
|
|
11
|
+
- `codeType`: options; optional
|
|
12
|
+
- Values: `js`, `py`
|
|
13
|
+
- `codeParams`: object; optional
|
|
14
|
+
- `globalParams`: object; optional
|
|
15
|
+
- `pauseAfterExecution`: boolean; optional
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
new Step({
|
|
21
|
+
id: 'core-code',
|
|
22
|
+
name: 'core.code',
|
|
23
|
+
type: 'core.code',
|
|
24
|
+
params: { /* use the required props and conditional values above */ },
|
|
25
|
+
});
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
Further reading: [Culvii core.code node](https://culvii.com/docs/nodes/core/code/).
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# core.http
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.http`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `method`: options; required
|
|
11
|
+
- Values: `GET`, `POST`, `PUT`, `PATCH`, `DELETE`, `HEAD`, `OPTIONS`
|
|
12
|
+
- `url`: string; required
|
|
13
|
+
- `authentication`: options; optional
|
|
14
|
+
- Values: `none`, `bearerToken`, `basicAuth`
|
|
15
|
+
- `bearerToken`: string; optional; when authentication=bearerToken
|
|
16
|
+
- `username`: string; optional; when authentication=basicAuth
|
|
17
|
+
- `password`: string; optional; when authentication=basicAuth
|
|
18
|
+
- `queryParameters`: object; optional
|
|
19
|
+
- `headers`: object; optional
|
|
20
|
+
- `bodyContentType`: options; optional
|
|
21
|
+
- Values: `json`, `form`, `form-urlencoded`, `raw`
|
|
22
|
+
- `body`: string; optional
|
|
23
|
+
- `responseFormat`: options; optional
|
|
24
|
+
- Values: `json`, `text`, `autodetect`
|
|
25
|
+
- `options`: object; optional
|
|
26
|
+
- `timeout`: number; optional
|
|
27
|
+
- `followRedirects`: boolean; optional
|
|
28
|
+
- `ignoreSSL`: boolean; optional
|
|
29
|
+
- `pauseAfterExecution`: boolean; optional
|
|
30
|
+
|
|
31
|
+
## Example
|
|
32
|
+
|
|
33
|
+
```ts
|
|
34
|
+
new Step({
|
|
35
|
+
id: 'core-http',
|
|
36
|
+
name: 'core.http',
|
|
37
|
+
type: 'core.http',
|
|
38
|
+
params: { /* use the required props and conditional values above */ },
|
|
39
|
+
});
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Further reading: [Culvii core.http node](https://culvii.com/docs/nodes/core/http/).
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# core.if
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.if`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `conditions`: array; required
|
|
11
|
+
- `combineOperation`: options; required
|
|
12
|
+
- Values: `all`, `any`
|
|
13
|
+
- `pauseAfterExecution`: boolean; optional
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
new Step({
|
|
19
|
+
id: 'core-if',
|
|
20
|
+
name: 'core.if',
|
|
21
|
+
type: 'core.if',
|
|
22
|
+
params: { /* use the required props and conditional values above */ },
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Further reading: [Culvii core.if node](https://culvii.com/docs/nodes/core/if/).
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# core.jwt
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.jwt`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `operation`: options; required
|
|
11
|
+
- Values: `sign`, `verify`
|
|
12
|
+
- `payload`: object; optional; when operation=sign
|
|
13
|
+
- `token`: string; optional; when operation=verify
|
|
14
|
+
- `secret`: string; required
|
|
15
|
+
- `expiresIn`: string; optional; when operation=sign
|
|
16
|
+
- `issuer`: string; optional
|
|
17
|
+
- `audience`: string; optional
|
|
18
|
+
- `pauseAfterExecution`: boolean; optional
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
new Step({
|
|
24
|
+
id: 'core-jwt',
|
|
25
|
+
name: 'core.jwt',
|
|
26
|
+
type: 'core.jwt',
|
|
27
|
+
params: { /* use the required props and conditional values above */ },
|
|
28
|
+
});
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Further reading: [Culvii core.jwt node](https://culvii.com/docs/nodes/core/jwt/).
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# core.loopBreak
|
|
2
|
+
|
|
3
|
+
- Type ID: `core.loopBreak`
|
|
4
|
+
- Kind: `action`
|
|
5
|
+
- Credentials: not required
|
|
6
|
+
- Feedback mock: not required
|
|
7
|
+
|
|
8
|
+
## Props
|
|
9
|
+
|
|
10
|
+
- `conditions`: array; required
|
|
11
|
+
- `combineOperation`: options; required
|
|
12
|
+
- Values: `all`, `any`
|
|
13
|
+
- `pauseAfterExecution`: boolean; optional
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
new Step({
|
|
19
|
+
id: 'core-loop-break',
|
|
20
|
+
name: 'core.loopBreak',
|
|
21
|
+
type: 'core.loopBreak',
|
|
22
|
+
params: { /* use the required props and conditional values above */ },
|
|
23
|
+
});
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Further reading: [Culvii core.loopBreak node](https://culvii.com/docs/nodes/core/loop-break/).
|