- 概要
- はじめに
- 概念
- Using UiPath CLI
- 使用ガイド
- CI/CD recipes
- コマンド リファレンス
- 概要
- 終了コード
- Global options
- uip codedagent
- uip docsai
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- プロジェクトを作成
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-workflow-examples
- pack
- 元に戻す
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- 移行
- Reference & support
UiPath CLI user guide
A Flow is a graph. Nodes are the vertices (triggers, activities, connectors, agents); edges are the directed connections between them. The uip flow node and uip flow edge commands edit a .flow file in place — adding, configuring, listing, and deleting both.
This page also covers three companion command groups that edit the .flow file in the same way: variable, variable-update, and binding.
Synopsis
uip flow node add <file> <node-type> [-i <json>] [--position <x,y>] [--label <label>] [--source <uuid>]
uip flow node configure <file> <node-id> --detail <json>
uip flow node list <file>
uip flow node delete <file> <node-id>
uip flow edge add <file> <source-id> <target-id> [--source-port <port>] [--target-port <port>]
uip flow edge list <file>
uip flow edge delete <file> <edge-id>
uip flow node add <file> <node-type> [-i <json>] [--position <x,y>] [--label <label>] [--source <uuid>]
uip flow node configure <file> <node-id> --detail <json>
uip flow node list <file>
uip flow node delete <file> <node-id>
uip flow edge add <file> <source-id> <target-id> [--source-port <port>] [--target-port <port>]
uip flow edge list <file>
uip flow edge delete <file> <edge-id>
Honors global options. Exit codes follow the standard contract.
uip flow node add
Add a node to a .flow file. The node type must exist in the registry — use uip flow registry search to discover valid <node-type> values.
Arguments:
<file>(required) — path to the.flowfile.<node-type>(required) — node type identifier (e.g.core.trigger.manual,uipath.connector.slack.send-message).
Options:
| オプション | 説明 |
|---|---|
-i, --input <json> | JSON object of input values to set on the node (e.g. '{"script":"…"}'). Must be a JSON object, not an array or scalar. For connector nodes (type uipath.connector.*), do not pass --input here — run node configure afterward. |
--position <x,y> | Canvas position, e.g. 250,150. Both x and y are required numbers. |
--label <label> | Display label for the node. |
--source <uuid> | Source identifier for inline agent nodes (populates model.source). |
例:
uip flow node add invoice-flow.flow uipath.connector.slack.send-message --label "Notify team"
uip flow node add invoice-flow.flow uipath.connector.slack.send-message --label "Notify team"
Data shape (--output json):
{
"Code": "NodeAddSuccess",
"Data": {
"Node": { "id": "node_a1b2c3d4", "type": "uipath.connector.slack.send-message" },
"DefinitionAdded": true,
"BindingsCreated": 0,
"VariableCount": 0
}
}
{
"Code": "NodeAddSuccess",
"Data": {
"Node": { "id": "node_a1b2c3d4", "type": "uipath.connector.slack.send-message" },
"DefinitionAdded": true,
"BindingsCreated": 0,
"VariableCount": 0
}
}
DefinitionAdded is true on the first insertion of a given node-type — the corresponding entry in the .flow definitions[] array is created.
uip flow node configure
Populate inputs.detail on an already-added node and create the workflow bindings it needs. Run this after node add for connector and managed-HTTP nodes.
Arguments:
<file>(required) — path to the.flowfile.<node-id>(required) — ID of the node to configure (find it withnode list).
Options:
--detail <json>(required) — configuration JSON. Shape depends on node type:
Connector nodes (uipath.connector.*)
Get method and endpoint from connectorMethodInfo in the registry get output.
- Required:
connectionId,folderKey,method,endpoint - Optional:
bodyParameters,queryParameters,pathParameters
uip flow node configure invoice-flow.flow node_a1b2c3d4 --detail '{
"connectionId": "b2c3d4e5-0000-0000-0000-000000000001",
"folderKey": "c3d4e5f6-0000-0000-0000-000000000001",
"method": "POST",
"endpoint": "/issues",
"bodyParameters": { "summary": "Bug" }
}'
uip flow node configure invoice-flow.flow node_a1b2c3d4 --detail '{
"connectionId": "b2c3d4e5-0000-0000-0000-000000000001",
"folderKey": "c3d4e5f6-0000-0000-0000-000000000001",
"method": "POST",
"endpoint": "/issues",
"bodyParameters": { "summary": "Bug" }
}'
Managed HTTP nodes (core.action.http.v2)
Two authentication modes:
Connector mode (authentication: "connector") — uses an Integration Service connection for auth:
- Required:
authentication,method,connectionId,folderKey,targetConnector method∈GET,POST,PUT,PATCH,DELETE,OPTIONS,HEAD- Optional:
url(path appended to connector base URL),headers,query,body
uip flow node configure invoice-flow.flow node_abc --detail '{
"authentication": "connector",
"targetConnector": "uipath-microsoft-outlook365",
"connectionId": "…",
"folderKey": "…",
"method": "GET",
"url": "/me"
}'
uip flow node configure invoice-flow.flow node_abc --detail '{
"authentication": "connector",
"targetConnector": "uipath-microsoft-outlook365",
"connectionId": "…",
"folderKey": "…",
"method": "GET",
"url": "/me"
}'
Manual mode (authentication: "manual") — no connector auth, provide the full URL and any auth headers yourself:
- Required:
authentication,method,url(full URL) - Optional:
headers,query,body(string; can be an expression, e.g.=js:({…}))
uip flow node configure invoice-flow.flow node_abc --detail '{
"authentication": "manual",
"method": "GET",
"url": "https://api.example.com/data",
"headers": { "Authorization": "Bearer <token>" }
}'
uip flow node configure invoice-flow.flow node_abc --detail '{
"authentication": "manual",
"method": "GET",
"url": "https://api.example.com/data",
"headers": { "Authorization": "Bearer <token>" }
}'
Data shape (--output json):
{
"Code": "NodeConfigureSuccess",
"Data": {
"NodeId": "node_a1b2c3d4",
"BindingsCreated": 2,
"DetailPopulated": true
}
}
{
"Code": "NodeConfigureSuccess",
"Data": {
"NodeId": "node_a1b2c3d4",
"BindingsCreated": 2,
"DetailPopulated": true
}
}
uip flow node list
List all nodes in a .flow file.
Arguments:
<file>(required) — path to the.flowfile.
Data shape (--output json):
{
"Code": "NodeListSuccess",
"Data": {
"Nodes": [
{ "id": "start", "type": "core.trigger.manual" },
{ "id": "node_a1b2c3d4", "type": "core.action.http.v2" }
],
"Count": 2
}
}
{
"Code": "NodeListSuccess",
"Data": {
"Nodes": [
{ "id": "start", "type": "core.trigger.manual" },
{ "id": "node_a1b2c3d4", "type": "core.action.http.v2" }
],
"Count": 2
}
}
Each entry includes at minimum id and type; the service also attaches display metadata from the .flow definitions[] array.
uip flow node delete
Delete a node and everything it owns. Removes:
- Connected edges
- Orphaned bindings
- Orphaned definitions
- Node variables owned by the deleted node
- Variable updates owned by the deleted node
Arguments:
<file>(required) — path to the.flowfile.<node-id>(required) — ID of the node to delete.
Data shape (--output json):
{
"Code": "NodeDeleteSuccess",
"Data": {
"DeletedNode": { "id": "node_a1b2c3d4", "type": "core.action.http.v2" },
"EdgesRemoved": 1,
"BindingsRemoved": 0,
"DefinitionsRemoved": 0,
"VariablesRemoved": 0,
"VariableUpdatesRemoved": 0
}
}
{
"Code": "NodeDeleteSuccess",
"Data": {
"DeletedNode": { "id": "node_a1b2c3d4", "type": "core.action.http.v2" },
"EdgesRemoved": 1,
"BindingsRemoved": 0,
"DefinitionsRemoved": 0,
"VariablesRemoved": 0,
"VariableUpdatesRemoved": 0
}
}
uip flow edge add
Add an edge between two nodes.
Arguments:
<file>(required) — path to the.flowfile.<source-id>(required) — ID of the source node.<target-id>(required) — ID of the target node.
Options:
--source-port <port>— source port name (default:output).--target-port <port>— target port name (default:input).
Data shape (--output json):
{
"Code": "EdgeAddSuccess",
"Data": {
"Edge": {
"id": "edge_a1b2c3d4",
"source": "Node_1",
"target": "Node_2",
"sourcePort": "output",
"targetPort": "input"
}
}
}
{
"Code": "EdgeAddSuccess",
"Data": {
"Edge": {
"id": "edge_a1b2c3d4",
"source": "Node_1",
"target": "Node_2",
"sourcePort": "output",
"targetPort": "input"
}
}
}
uip flow edge list
{
"Code": "EdgeListSuccess",
"Data": {
"Edges": [
{ "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
],
"Count": 1
}
}
{
"Code": "EdgeListSuccess",
"Data": {
"Edges": [
{ "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
],
"Count": 1
}
}
uip flow edge delete
Delete a single edge by ID. Use edge list to find the ID.
{
"Code": "EdgeDeleteSuccess",
"Data": {
"DeletedEdge": { "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
}
}
{
"Code": "EdgeDeleteSuccess",
"Data": {
"DeletedEdge": { "id": "edge_a1b2c3d4", "source": "Node_1", "target": "Node_2" }
}
}
Variables and variable updates
Two companion command groups (not yet in the sidebar) edit the variables and variable-update subtrees of a .flow file.
uip flow variable
uip flow variable add <file> <variable-id> -d <direction> [-t <type>] [--default-value <val>] [--description <text>] [--schema <json>] [--sub-type <type>]
uip flow variable list <file>
uip flow variable delete <file> <variable-id>
uip flow variable add <file> <variable-id> -d <direction> [-t <type>] [--default-value <val>] [--description <text>] [--schema <json>] [--sub-type <type>]
uip flow variable list <file>
uip flow variable delete <file> <variable-id>
direction∈in,out,inout(required).type∈string,number,boolean,object,array,file(defaultstring).--default-valueis parsed per--type—object/arrayvalues must be valid JSON of the matching shape.--schemamust be a JSON object (e.g.'{"type":"string"}').
Data shapes: VariableAddSuccess (Data.Variable), VariableListSuccess (Data.Variables[], Count), VariableDeleteSuccess (Data.DeletedVariable).
uip flow variable-update
Attach a JS expression to a node that runs on completion and assigns to a global variable (which must be out or inout).
uip flow variable-update add <file> --node-id <id> --variable-id <id> --expression <expr>
uip flow variable-update list <file> [--node-id <id>]
uip flow variable-update delete <file> <node-id> <variable-id>
uip flow variable-update add <file> --node-id <id> --variable-id <id> --expression <expr>
uip flow variable-update list <file> [--node-id <id>]
uip flow variable-update delete <file> <node-id> <variable-id>
The expression is auto-prefixed with =js: if missing. Example: --expression "=js:ctx.output".
Data shapes: VariableUpdateAddSuccess (Data.VariableUpdate), VariableUpdateListSuccess (Data.VariableUpdates[], Count), VariableUpdateDeleteSuccess (Data.DeletedUpdate).
Bindings
Bindings declare the external resources a Flow needs at publish/deploy time (a target process, an agent, a connection, a queue, …) and which node property they wire into.
uip flow binding add <file> <name> <resource> <default-value> [--resource-key <key>] [--property-attribute <attr>] [--resource-sub-type <type>]
uip flow binding list <file>
uip flow binding delete <file> <resource-key>
uip flow binding add <file> <name> <resource> <default-value> [--resource-key <key>] [--property-attribute <attr>] [--resource-sub-type <type>]
uip flow binding list <file>
uip flow binding delete <file> <resource-key>
<resource>must be one of the service'sVALID_RESOURCE_TYPES(shown in theaddcommand's error message if an invalid value is passed).--property-attributeis the target node property the binding populates (e.g.name,folderPath,connection).--resource-sub-typeprovides sub-classification (e.g.Agent,Process).binding deleteremoves all bindings with the given resource key, not a single entry by ID.
Data shapes: BindingAddSuccess (Data.Binding), BindingListSuccess (Data.Bindings[], Count), BindingDeleteSuccess (Data.DeletedBindings[], Count).
uip flow tidy
Auto-layout: reposition nodes in a .flow file to remove overlaps and arrange the graph cleanly.
uip flow tidy <file>
uip flow tidy <file>
Data shape: Code: "FlowTidy", Data: { File, NodesTotal, EdgesTotal, NodesRepositioned }.
参照
uip flow registry— discover node typesuip flow validate— validate the edited.flowuip flow init- Flow overview
- Synopsis
- uip flow node add
- uip flow node configure
- Connector nodes (uipath.connector.*)
- Managed HTTP nodes (core.action.http.v2)
- uip flow node list
- uip flow node delete
- uip flow edge add
- uip flow edge list
- uip flow edge delete
- Variables and variable updates
- uip flow variable
- uip flow variable-update
- Bindings
- uip flow tidy
- 参照