UiPath Documentation
uipath-cli
latest
false
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

Guia do usuário da UiPath CLI

Fluxo de UIP

uip flow , pacotes, depurações e opera projetos UiPath Flow — fluxos de trabalho em forma de gráficos feitos de nós (atividades, gatilhos, conectores) conectados por bordas. Flow é uma das duas superfície de orquestração no UiPath; consulte uip maestro para orquestração de processos de negócios baseada em BPMN.

A ferramenta é enviada como o plug-in @uipath/flow-tool (prefixo de comando flow). Consulte Ferramentas ( plugins ) para saber como os plug-ins são instalados e versionados.

Quando usar Flow versus Maestro

SuperfícieForma de gráficoArquivo do ativoCaso de uso principal
FluxoGráfico visual de nós e borda.flow (JSON)Fluxos de trabalho de agentes, automações de conectores, encadeamento de nós de IA
MaestroDiagrama do BPMN 2.0.bpmnOrquestração de processos de negócios de longa duração com intervenção humana

Ambas as ferramentas publicam pacotes .nupkg no Orchestrator e compartilham os primitivos de runtime (processes, instance, incident, job, registry).

Fluxo de criação

Um projeto de fluxo é um diretório com um manifesto project.uiproj e um ou mais arquivos .flow (além dos arquivos de suporte gerados no momento do pacote).

# 1. Scaffold a new project
uip flow init invoice-flow

# 2. Discover nodes in the registry
uip flow registry pull
uip flow registry search slack

# 3. Edit the .flow file — add nodes, edges, variables, bindings
uip flow node add invoice-flow/invoice-flow.flow uipath.connector.slack.send-message --label "Notify"
uip flow edge add invoice-flow/invoice-flow.flow start node_a1b2c3d4
uip flow node configure invoice-flow/invoice-flow.flow node_a1b2c3d4 --detail '{"connectionId":"…","folderKey":"…","method":"POST","endpoint":"/…"}'

# 4. Validate structure (and optionally governance policy)
uip flow validate invoice-flow/invoice-flow.flow

# 5. Run against Studio Web to smoke-test
uip flow debug ./invoice-flow

# 6. Pack for deployment
uip flow pack ./invoice-flow ./dist --version 1.0.0
# 1. Scaffold a new project
uip flow init invoice-flow

# 2. Discover nodes in the registry
uip flow registry pull
uip flow registry search slack

# 3. Edit the .flow file — add nodes, edges, variables, bindings
uip flow node add invoice-flow/invoice-flow.flow uipath.connector.slack.send-message --label "Notify"
uip flow edge add invoice-flow/invoice-flow.flow start node_a1b2c3d4
uip flow node configure invoice-flow/invoice-flow.flow node_a1b2c3d4 --detail '{"connectionId":"…","folderKey":"…","method":"POST","endpoint":"/…"}'

# 4. Validate structure (and optionally governance policy)
uip flow validate invoice-flow/invoice-flow.flow

# 5. Run against Studio Web to smoke-test
uip flow debug ./invoice-flow

# 6. Pack for deployment
uip flow pack ./invoice-flow ./dist --version 1.0.0

Criando comandos

CommandFinalidade
uip flow initEstruturar um novo projeto de fluxo
uip flow nodeAdicionar, configurar, listar e excluir nós em um arquivo .flow
uip flow edgeAdicionar, listar e excluir bordas entre nós
uip flow validateValidar um arquivo .flow em relação ao esquema (e à política de governança)
uip flow debugCarregue o projeto para o Studio Web e execute uma sessão de depuração
uip flow packProduzir um implantável .nupkg
uip flow registryNavegue e pesquise os tipos de nó disponíveis (OTB + conector)

Auxiliares de variável, associação e layout

Essas superfícies de CLI ainda não estão na barra lateral, mas podem ser chamadas hoje — elas são wrapper finos para editar o JSON .flow programaticamente:

  • uip flow variable adicionar/listar/excluir variáveis de fluxo de trabalho de nível superior (in, out, inout). Consulte node-edge.md.
  • uip flow variable-update — anexe uma expressão de atribuição JS a um nó (=js:ctx.output) que é executado na conclusão.
  • uip flow binding adicionar / listar / excluir associações de recursos (processo, agente, conexão etc.) que são resolvidas no momento da publicação.
  • — layout uip flow tidy : reposicionar nós para remover sobreposições.

Runtime

No runtime, um pacote de fluxo publicado torna-se um processo no Orchestrator. Iniciar um cria uma instância; cada tentativa de execução é um trabalho; as falhas aparecem como incidentes.

CommandFinalidade
uip flow processListar e executar processos de fluxo implantados (list, get, run)
uip flow processesResumos de processos em pastas e incidentes por processo
uip flow instancesInspecionar e orientar instâncias em execução (list, get, pause, resume, cancel, retry, migrate, goto, variables,…)
uip flow incidentsLer resumos e detalhes de incidentes
uip flow jobTransmitir rastreamentos (traces) e inspecionar o status dos trabalhos

Trabalhos e processos no Orchestrator devidamente são manipulados por meio da ferramenta do Orchestrator — consulte Trabalhos do Orchestrator e Processos do Orchestrator.

Convenções

  • Cada uip flow subcomando honra as opções globais (--output, --output-filter, --log-level, --log-file).
  • A saída padrão é JSON.
  • Os códigos de saída seguem o contrato padrão.
  • A maioria dos comandos de runtime requer uip login primeiro — consulte Autenticação.

Veja também

  • Quando usar Flow versus Maestro
  • Fluxo de criação
  • Criando comandos
  • Auxiliares de variável, associação e layout
  • Runtime
  • Convenções
  • Veja também

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades