@@ -59,8 +59,10 @@ uv run uipath init --infer-bindings
5959| ` --input-file ` | value | ` Sentinel.UNSET ` | Alias for '-f/--file' arguments |
6060| ` --output-file ` | value | ` Sentinel.UNSET ` | File path where the output will be written |
6161| ` --trace-file ` | value | ` Sentinel.UNSET ` | File path where the trace spans will be written (JSON Lines format) |
62+ | ` --state-file ` | value | ` Sentinel.UNSET ` | File path where the state file is stored for persisting execution state. If not provided, a temporary file will be used. |
6263| ` --debug ` | flag | false | Enable debugging with debugpy. The process will wait for a debugger to attach. |
6364| ` --debug-port ` | value | ` 5678 ` | Port for the debug server (default: 5678) |
65+ | ` --keep-state-file ` | flag | false | Keep the temporary state file even when not resuming and no job id is provided |
6466
6567** Usage Examples:**
6668
@@ -98,6 +100,11 @@ uv run uipath run --resume
98100 no_report: Do not report the evaluation results
99101 enable_mocker_cache: Enable caching for LLM mocker responses
100102 report_coverage: Report evaluation coverage
103+ model_settings_id: Model settings ID to override agent settings
104+ trace_file: File path where traces will be written in JSONL format
105+ max_llm_concurrency: Maximum concurrent LLM requests
106+ input_overrides: Input field overrides mapping (direct field override with deep merge)
107+ resume: Resume execution from a previous suspended state
101108
102109
103110** Arguments:**
@@ -117,6 +124,10 @@ uv run uipath run --resume
117124| ` --output-file ` | value | ` Sentinel.UNSET ` | File path where the output will be written |
118125| ` --enable-mocker-cache ` | flag | false | Enable caching for LLM mocker responses |
119126| ` --report-coverage ` | flag | false | Report evaluation coverage |
127+ | ` --model-settings-id ` | value | ` "default" ` | Model settings ID from evaluation set to override agent settings (default: 'default') |
128+ | ` --trace-file ` | value | ` Sentinel.UNSET ` | File path where traces will be written in JSONL format |
129+ | ` --max-llm-concurrency ` | value | ` 20 ` | Maximum concurrent LLM requests (default: 20) |
130+ | ` --resume ` | flag | false | Resume execution from a previous suspended state |
120131
121132** Usage Examples:**
122133
@@ -218,343 +229,3 @@ The `uipath.json` file is automatically generated by `uipath init` and defines y
218229- The ` jsonSchema ` must match your Pydantic models exactly
219230- Re-run ` uipath init --infer-bindings ` instead of manual edits when possible
220231
221-
222- ## Service Commands Reference
223-
224- The UiPath CLI provides commands for interacting with UiPath platform services. These commands allow you to manage buckets, assets, jobs, and other resources.
225-
226- ### ` uipath buckets `
227-
228- Manage UiPath storage buckets and files.
229-
230- Buckets are cloud storage containers for files used by automation processes.
231-
232-
233- Bucket Operations:
234- list - List all buckets
235- create - Create a new bucket
236- delete - Delete a bucket
237- retrieve - Get bucket details
238- exists - Check if bucket exists
239-
240-
241- File Operations (use 'buckets files' subcommand):
242- files list - List files in a bucket
243- files search - Search files using glob patterns
244- files upload - Upload a file to a bucket
245- files download - Download a file from a bucket
246- files delete - Delete a file from a bucket
247- files exists - Check if a file exists
248-
249-
250- Examples:
251-
252- # Bucket operations with explicit folder
253- uipath buckets list --folder-path "Shared"
254- uipath buckets create my-bucket --description "Data storage"
255- uipath buckets exists my-bucket
256- uipath buckets delete my-bucket --confirm
257-
258- # Using environment variable for folder context
259- export UIPATH_FOLDER_PATH="Shared"
260- uipath buckets list
261- uipath buckets create my-bucket --description "Data storage"
262-
263- # File operations
264- uipath buckets files list my-bucket
265- uipath buckets files search my-bucket "* .pdf"
266- uipath buckets files upload my-bucket ./data.csv remote/data.csv
267- uipath buckets files download my-bucket data.csv ./local.csv
268- uipath buckets files delete my-bucket old-data.csv --confirm
269- uipath buckets files exists my-bucket data.csv
270-
271-
272- ** Subcommands:**
273-
274- ** ` uipath buckets create ` **
275-
276- Create a new Bucket.
277-
278- Examples:
279- uipath buckets create my-resource
280- uipath buckets create my-resource --folder-path Shared
281-
282-
283- Arguments:
284- - ` name ` (required): N/A
285-
286- Options:
287- - ` --description ` : Bucket description
288- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
289- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
290- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
291- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
292-
293- ** ` uipath buckets delete ` **
294-
295- Delete a bucket.
296-
297-
298- Examples:
299- uipath buckets delete my-bucket --confirm
300- uipath buckets delete my-bucket --dry-run
301-
302-
303- Arguments:
304- - ` name ` (required): N/A
305-
306- Options:
307- - ` --confirm ` : Skip confirmation prompt
308- - ` --dry-run ` : Show what would be deleted without deleting
309- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
310- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
311- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
312- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
313-
314- ** ` uipath buckets exists ` **
315-
316- Check if a Bucket exists.
317-
318- Examples:
319- uipath buckets exists my-resource
320- uipath buckets exists my-resource --folder-path Shared
321-
322-
323- Arguments:
324- - ` name ` (required): N/A
325-
326- Options:
327- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
328- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
329- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
330- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
331-
332- #### ` uipath buckets files `
333-
334- Manage files within buckets.
335-
336-
337- Examples:
338-
339- # List files in a bucket
340- uipath buckets files list my-bucket
341-
342- # Search for files with glob pattern
343- uipath buckets files search my-bucket "*.pdf"
344-
345- # Upload a file
346- uipath buckets files upload my-bucket ./data.csv remote/data.csv
347-
348- # Download a file
349- uipath buckets files download my-bucket data.csv ./local.csv
350-
351- # Delete a file
352- uipath buckets files delete my-bucket old-data.csv --confirm
353-
354- # Check if file exists
355- uipath buckets files exists my-bucket data.csv
356-
357-
358- ** ` uipath buckets files delete ` **
359-
360- Delete a file from a bucket.
361-
362-
363- Arguments:
364- BUCKET_NAME: Name of the bucket
365- FILE_PATH: Path to file in bucket
366-
367-
368- Examples:
369- uipath buckets files delete my-bucket old-data.csv --confirm
370- uipath buckets files delete reports archive/old.pdf --dry-run
371-
372-
373- Arguments:
374- - ` bucket_name ` (required): N/A
375- - ` file_path ` (required): N/A
376-
377- Options:
378- - ` --confirm ` : Skip confirmation prompt
379- - ` --dry-run ` : Show what would be deleted
380- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
381- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
382- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
383- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
384-
385- ** ` uipath buckets files download ` **
386-
387- Download a file from a bucket.
388-
389-
390- Arguments:
391- BUCKET_NAME: Name of the bucket
392- REMOTE_PATH: Path to file in bucket
393- LOCAL_PATH: Local destination path
394-
395-
396- Examples:
397- uipath buckets files download my-bucket data.csv ./downloads/data.csv
398- uipath buckets files download reports monthly/report.pdf ./report.pdf
399-
400-
401- Arguments:
402- - ` bucket_name ` (required): N/A
403- - ` remote_path ` (required): N/A
404- - ` local_path ` (required): N/A
405-
406- Options:
407- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
408- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
409- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
410- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
411-
412- ** ` uipath buckets files exists ` **
413-
414- Check if a file exists in a bucket.
415-
416-
417- Arguments:
418- BUCKET_NAME: Name of the bucket
419- FILE_PATH: Path to file in bucket
420-
421-
422- Examples:
423- uipath buckets files exists my-bucket data.csv
424- uipath buckets files exists reports monthly/report.pdf
425-
426-
427- Arguments:
428- - ` bucket_name ` (required): N/A
429- - ` file_path ` (required): N/A
430-
431- Options:
432- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
433- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
434- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
435- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
436-
437- ** ` uipath buckets files list ` **
438-
439- List files in a bucket.
440-
441-
442- Arguments:
443- BUCKET_NAME: Name of the bucket
444-
445-
446- Examples:
447- uipath buckets files list my-bucket
448- uipath buckets files list my-bucket --prefix "data/"
449- uipath buckets files list reports --limit 10 --format json
450- uipath buckets files list my-bucket --all
451-
452-
453- Arguments:
454- - ` bucket_name ` (required): N/A
455-
456- Options:
457- - ` --prefix ` : Filter files by prefix (default: ``)
458- - ` --limit ` : Maximum number of files to return (default: ` Sentinel.UNSET ` )
459- - ` --offset ` : Number of files to skip (default: ` 0 ` )
460- - ` --all ` : Fetch all files (auto-paginate)
461- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
462- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
463- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
464- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
465-
466- ** ` uipath buckets files search ` **
467-
468- Search for files using glob patterns.
469-
470- Uses the GetFiles API which supports glob patterns like *.pdf or data_*.csv.
471-
472-
473- Arguments:
474- BUCKET_NAME: Name of the bucket
475- PATTERN: Glob pattern to match files (e.g., "*.pdf", "data_*.csv")
476-
477-
478- Examples:
479- uipath buckets files search my-bucket "*.pdf"
480- uipath buckets files search reports "*.csv" --recursive
481- uipath buckets files search my-bucket "data_*.json" --prefix "archive/"
482-
483-
484- Arguments:
485- - ` bucket_name ` (required): N/A
486- - ` pattern ` (required): N/A
487-
488- Options:
489- - ` --prefix ` : Directory path to search in (default: ``)
490- - ` --recursive ` : Search subdirectories recursively
491- - ` --limit ` : Maximum number of files to return (default: ` Sentinel.UNSET ` )
492- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
493- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
494- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
495- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
496-
497- ** ` uipath buckets files upload ` **
498-
499- Upload a file to a bucket.
500-
501-
502- Arguments:
503- BUCKET_NAME: Name of the bucket
504- LOCAL_PATH: Local file to upload
505- REMOTE_PATH: Destination path in bucket
506-
507-
508- Examples:
509- uipath buckets files upload my-bucket ./data.csv remote/data.csv
510- uipath buckets files upload reports ./report.pdf monthly/report.pdf
511-
512-
513- Arguments:
514- - ` bucket_name ` (required): N/A
515- - ` local_path ` (required): N/A
516- - ` remote_path ` (required): N/A
517-
518- Options:
519- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
520- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
521- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
522- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
523-
524- ** ` uipath buckets list ` **
525-
526- List all Buckets.
527-
528- Examples:
529- uipath buckets list
530- uipath buckets list --folder-path Shared
531-
532-
533- Options:
534- - ` --limit ` : Maximum number of items to return (default: ` Sentinel.UNSET ` )
535- - ` --offset ` : Number of items to skip (default: ` 0 ` )
536- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
537- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
538- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
539- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
540-
541- ** ` uipath buckets retrieve ` **
542-
543- Retrieve a bucket by name or key.
544-
545-
546- Examples:
547- uipath buckets retrieve --name "my-bucket"
548- uipath buckets retrieve --key "abc-123-def-456" --format json
549-
550-
551- Options:
552- - ` --name ` : Bucket name (default: ` Sentinel.UNSET ` )
553- - ` --key ` : Bucket key (UUID) (default: ` Sentinel.UNSET ` )
554- - ` --folder-path ` : Folder path (e.g., "Shared"). Can also be set via UIPATH_FOLDER_PATH environment variable. (default: ` Sentinel.UNSET ` )
555- - ` --folder-key ` : Folder key (UUID) (default: ` Sentinel.UNSET ` )
556- - ` --format ` : Output format (overrides global) (default: ` Sentinel.UNSET ` )
557- - ` --output ` , ` -o ` : Output file (overrides global) (default: ` Sentinel.UNSET ` )
558-
559- ---
560-
0 commit comments