uipath-cli
latest
false
- Visão geral
- Introdução
- Conceitos
- Using UiPath CLI
- Guias de instruções
- CI/CD recipes
- Referência de comando
- Visão geral
- Códigos de saída
- Global options
- uip codedagent
- uip docsai
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- criar projeto
- 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
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migração
- Reference & support
UiPath CLI user guide
Última atualização 7 de mai de 2026
uip flow debug uploads a local Flow project to Studio Web and runs a server-side debug session, streaming per-element status updates back to the console and returning a final status.
Synopsis
uip flow debug <project-path>
[--folder-id <id>]
[--poll-interval <ms>]
[-i, --inputs <json>]
[--login-validity <minutes>]
uip flow debug <project-path>
[--folder-id <id>]
[--poll-interval <ms>]
[-i, --inputs <json>]
[--login-validity <minutes>]
Requires uip login. Honors global options. Exit codes follow the standard contract.
Argumentos
<project-path>(required) — path to the Flow project directory. Must contain aproject.uiproj.
Opções
| Opção | Padrão | Description |
|---|---|---|
--folder-id <id> | auto-detected | Orchestrator folder (OrganizationUnitId). If omitted, the folder on the current login session is used. Parsed as an integer. |
--poll-interval <ms> | 2000 | Polling interval in milliseconds while waiting for Studio Web to advance the session. |
-i, --inputs <json> | — | Input arguments as a JSON string, or @path/to/file.json to read from a file. Also read from stdin if neither is provided (via uip flow process run, not here — debug accepts JSON string or @file only). |
--login-validity <minutes> | 10 | Minimum minutes before token expiration to trigger an automatic refresh. |
Comportamento
- Validates login and pulls the organization, tenant, base URL, organization name, and auth token from the session.
- Uploads the project to Studio Web under the target folder.
- Polls for a final status, emitting per-element status lines like:
Status: InProgress (2/5 elements completed) v Node_1 [Completed] > Node_2 [InProgress] - Node_3 [NotStarted]Status: InProgress (2/5 elements completed) v Node_1 [Completed] > Node_2 [InProgress] - Node_3 [NotStarted] - On incidents during the run, emits a warning line.
- Exits
0iffinalStatusisCompletedorSuccessful;1otherwise.
Exemplos
# Debug a local project, auto-detect folder, default poll interval
uip flow debug ./invoice-flow
# Debug against a specific folder with inline JSON inputs
uip flow debug ./invoice-flow --folder-id 2553016 \
--inputs '{"amount":100,"customer":"Acme"}'
# Debug with inputs from a file
uip flow debug ./invoice-flow --inputs @inputs.json
# Slower polling for long-running flows
uip flow debug ./invoice-flow --poll-interval 5000
# Debug a local project, auto-detect folder, default poll interval
uip flow debug ./invoice-flow
# Debug against a specific folder with inline JSON inputs
uip flow debug ./invoice-flow --folder-id 2553016 \
--inputs '{"amount":100,"customer":"Acme"}'
# Debug with inputs from a file
uip flow debug ./invoice-flow --inputs @inputs.json
# Slower polling for long-running flows
uip flow debug ./invoice-flow --poll-interval 5000
Data shape (--output json)
{
"Code": "FlowDebug",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"runId": "d4e5f6a7-0000-0000-0000-000000000001",
"finalStatus": "Completed",
"solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
"studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
"elementExecutions": [
{ "elementId": "Node_1", "status": "Completed" }
],
"variables": {}
}
}
{
"Code": "FlowDebug",
"Data": {
"jobKey": "b2c3d4e5-0000-0000-0000-000000000001",
"instanceId": "c3d4e5f6-0000-0000-0000-000000000001",
"runId": "d4e5f6a7-0000-0000-0000-000000000001",
"finalStatus": "Completed",
"solutionId": "e5f6a7b8-0000-0000-0000-000000000001",
"studioWebUrl": "https://cloud.uipath.com/org/tenant/studio_/debug/e5f6a7b8",
"elementExecutions": [
{ "elementId": "Node_1", "status": "Completed" }
],
"variables": {}
}
}
Open studioWebUrl in a browser to inspect the session interactively.
Veja também
uip flow validate— static check before runninguip flow process run— run a published processuip flow job traces— stream traces for an already-started job- Autenticação
- Flow overview