@uipath/flow-tool 1.0.4 → 1.1.0

package/README.md

@@ -25,7 +25,7 @@ uip maestro flow validate <flowFile>
 Pack a Flow project into a NuGet package (`.nupkg`).
 
 ```bash
-uip maestro flow pack <projectPath> <outputPath> [-n <name>] [-v <version>]
+uip maestro flow pack <project-path> <output-path> [-n <name>] [-v <version>]
 ```
 
 ### Known Issues
@@ -42,10 +42,12 @@ uip maestro flow pack <projectPath> <outputPath> [-n <name>] [-v <version>]
 
 #### `flow process list`
 
-List available Flow processes.
+List available Flow processes in a folder. Provide either `--folder-key`
+(GUID) or `--folder-path` (e.g. `Shared/Invoices`).
 
 ```bash
-uip maestro flow process list
+uip maestro flow process list --folder-key "<folder-key>"
+uip maestro flow process list --folder-path "Shared/Invoices"
 ```
 
 #### `flow process get`
@@ -53,10 +55,10 @@ uip maestro flow process list
 Get Flow process schema and details.
 
 ```bash
-uip maestro flow process get "<process-key>" "<feed-id>"
+uip maestro flow process get "<process-key>" "<feed-id>" --folder-key "<folder-key>"
 
 # Example
-uip maestro flow process get "MyFlow.flow.Flow:1.0.0" "6d98ceb8-becb-46ec-80d7-df213fbec06c"
+uip maestro flow process get "MyFlow.flow.Flow:1.0.0" "6d98ceb8-becb-46ec-80d7-df213fbec06c" --folder-key "c3d4e5f6-0000-0000-0000-000000000001"
 ```
 
 #### `flow process run`
@@ -79,7 +81,6 @@ uip maestro flow process run "<process-key>" "<folder-key>" [options]
 - `-i, --inputs <json>` - Input parameters as JSON string or @file.json
 - `-t, --tenant <name>` - Tenant name (defaults to authenticated tenant)
 - `--release-key <key>` - Release key (GUID, from list command)
-- `--folder-id <id>` - Folder ID (from list command)
 - `--feed-id <id>` - Feed ID for package lookup (optional)
 - `--robot-ids <ids>` - Comma-separated robot IDs (optional)
 - `--validate` - Validate inputs against project schema before running
@@ -90,20 +91,17 @@ uip maestro flow process run "<process-key>" "<folder-key>" [options]
 # Run with JSON inputs
 uip maestro flow process run "TestFlow.flow.Flow:1.0.0" "folder-guid-here" \
   --release-key "release-guid" \
-  --folder-id "2553016" \
   --inputs '{"name": "John", "age": 30}'
 
 # Run with inputs from file
 uip maestro flow process run "TestFlow.flow.Flow:1.0.0" "folder-guid-here" \
   --release-key "release-guid" \
-  --folder-id "2553016" \
   --inputs @inputs.json
 
 # Run with piped inputs
 echo '{"name": "John", "age": 30}' | \
   uip maestro flow process run "TestFlow.flow.Flow:1.0.0" "folder-guid-here" \
-  --release-key "release-guid" \
-  --folder-id "2553016"
+  --release-key "release-guid"
 ```
 
 ### Flow Job Commands
@@ -128,35 +126,34 @@ uip maestro flow job traces "06478292-f9cf-4234-9d1b-03f4bcd95fed"
 Get detailed status of a Flow job.
 
 ```bash
-uip maestro flow job status "<job-key>" --folder-id "<id>" [options]
+uip maestro flow job status "<job-key>" --folder-key "<key>" [options]
 
 # Options:
 # --detailed  - Show full response with all fields
 
 # Example
-uip maestro flow job status "06478292-f9cf-4234-9d1b-03f4bcd95fed" --folder-id "2553016"
+uip maestro flow job status "06478292-f9cf-4234-9d1b-03f4bcd95fed" --folder-key "c3d4e5f6-0000-0000-0000-000000000001"
 ```
 
 ## Complete Workflow
 
 ```bash
 # 1. List available processes
-uip maestro flow process list
+uip maestro flow process list --folder-key "folder-key"
 
 # 2. Get process schema (to see required inputs)
-uip maestro flow process get "MyFlow.flow.Flow:1.0.0" "feed-id-from-list"
+uip maestro flow process get "MyFlow.flow.Flow:1.0.0" "feed-id-from-list" --folder-key "folder-key"
 
 # 3. Run the process
 JOB_KEY=$(uip maestro flow process run "MyFlow.flow.Flow:1.0.0" "folder-key" \
   --release-key "release-key" \
-  --folder-id "2553016" \
-  --inputs '{}' 2>/dev/null)
+  --inputs '{}')
 
 # 4. Watch execution traces
 uip maestro flow job traces "$JOB_KEY"
 
 # 5. Check final status
-uip maestro flow job status "$JOB_KEY" --folder-id "2553016"
+uip maestro flow job status "$JOB_KEY" --folder-key "folder-key"
 ```
 
 ## Output
@@ -181,7 +178,7 @@ uip maestro flow job status "$JOB_KEY" --folder-id "2553016"
 | `flow registry pull`              | Fetch and cache all available nodes from the Flow registry                     |
 | `flow registry list`              | List all locally cached nodes                                                  |
 | `flow registry search [keyword]`  | Find nodes by keyword and/or structured filters                                |
-| `flow registry get <nodeType>`    | Get full node schema; auto-enriches connector nodes with input/output fields   |
+| `flow registry get <node-type>`   | Get full node schema; auto-enriches connector nodes with input/output fields   |
 
 ---