- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- Guias de instruções
- Receitas de CI/CD
- Referência de comando
- Visão geral
- Códigos de saída
- Opções globais
- Agente de código uip
- Documento da UIP
- adicionar-tipo-dados-de-teste
- adicionar-dados-de-teste-fila
- adicionar-teste-variação de dados
- Analisar
- Criar
- criar projeto
- Comparação
- encontrar atividades
- obter-analisador-regras
- obter-padrão-atividade-xaml
- obter-erros
- obter-casos-de-teste-manuais
- obter-etapas-de-teste-manual
- Obter versões
- obter-fluxo-de-trabalho-exemplo
- indicar aplicativo
- indicar elemento
- inspecionar pacote
- instalar-data-fabric-entities
- instalar-ou-atualizar pacotes
- listar-data-fabric-entities
- listar-exemplos-de-fluxo-de-trabalho
- Empacotar
- restore
- arquivo de execução
- modelos-pesquisar
- Iniciar Studio
- interromper a execução
- UIA
- Traces da UIP
- Migração
- Referência e suporte
uip or a ferramenta do Orchestrator: ele gerencia trabalhos, pastas, processos, pacotes, máquinas, usuários, funções, licenças, feeds e anexos em um tenant do UiPath Orchestrator. Instale-o com uip tools install or ou invoque uip or … e deixe a instalação automática ser executada. Consulte Ferramentas ( plugins ) para ver o modelo de instalação e ferramentas uip para o comando que gerencia a instalação da ferramenta.
Recursos
Cada recurso tem sua própria página de referência. O verbo definido em cada página corresponde aos comandos registrados por uip or — execute uip or --help para confirmar a superfície completa em sua instalação.
| Recurso | Finalidade |
|---|---|
| Trabalhos | Iniciar, parar, reiniciar, retomar e inspecionar execuções de processos; buscar logs, traces, dados de correção e o histórico do estado. |
| Pastas | Criar, listar, mover, editar e excluir pastas; inspecionar a alocação de runtime. |
| Processos | associe pacotes a pastas como processos executáveis; atualizar, reverter e editar. |
| Pacotes | Carregar, baixar, listar e inspecionar .nupkg pacotes de automação e seus pontos de entrada. |
| Máquinas | Gerenciar modelos de máquina e alocações de slots; atribuir máquinas a pastas. |
| usuários | Criar, editar, excluir e atribuir usuários do Orchestrator; gerenciar atribuições de função no nível do tenant. |
| Funções | Gerencie funções, permissões e associação de usuário de função no escopo do tenant e da pasta. |
| Licenças | Listar atribuições de licenças de runtime e Named-User; alternar o licenciamento da máquina; visualizar o resumo da licença do tenant. |
| Feeds | Lista os feeds de pacote disponíveis para o usuário atual. |
| Anexos | Listar e baixar anexos de trabalho. |
Resumo
uip or <resource> <verb> [options]
uip or <resource> <verb> [options]
Sempre uip or, nunca uip orchestrator. or é o prefixo de comando da ferramenta (consulte a coluna commandPrefix em uip tools list).
Como ler esta seção
Cada página de recurso é estruturada da mesma maneira:
- Resumo — a forma de comando
uip or <resource> <verb>. - Verbos — uma tabela de uma linha de cada verbo que o recurso expõe.
- Um H2 por verbo — descrição, argumentos posicionais (se houver), tabela de sinalizador, três exemplos (mais simples, caso comum, amigável ao script com
--output-filter) e a formaDataretornada sob--output json. - Códigos de saída — um ponteiro para o contrato de códigos de saída compartilhado, com quaisquer substituições específicas do verbo chamadas em linha.
- Comandos relacionados e Consulte também — links cruzados para recursos irmãos e páginas de conceito relevantes.
O formato de saída padrão é --output json. As formas de dados em cada página refletem a carga JSON — as renderizações de tabela, yaml e simples são derivadas do mesmo objeto Data .
Sinalizadores comuns
Um pequeno conjunto de sinalizadores é recorrente na maioria dos recursos. Elas se comportam da mesma maneira onde quer que apareçam:
| Bandeira | Usado por | Finalidade |
|---|---|---|
-t, --tenant <tenant-name> | cada verbo | Substitui o tenant selecionado no momento da autenticação. Opcional; omita para usar o padrão da sessão. Consulte Autenticação. |
--folder-path <path> | a maioria dos verbos que abrangem uma pasta | Pasta de destino por caminho totalmente qualificado (por exemplo, Shared, Production/EU). |
--folder-key <key> | a maioria dos verbos que abrangem uma pasta | Pasta de destino por GUID. Mutualmente usado com --folder-path; resolve a mesma pasta. |
-l, --limit <number> | cada verbo de lista | Tamanho da página O padrão é o da CLI DEFAULT_PAGE_SIZE (50 no momento da escrita). |
--offset <number> | cada verbo de lista | Número de itens a ignorar antes de retornar. O padrão é 0. |
--order-by <field> | mais verbos da lista | Expressão de classificação OData (por exemplo, Name asc, Id desc). Cada verbo documenta seu padrão. |
--all-fields | muitos list / get verbos | Retorna a resposta da API bruta em vez do resumo selecionado. Útil quando você precisa de campos que a forma padrão omite. |
Os sinalizadores no nível do verbo (filtros, caminhos de entrada/saída, estratégias, prioridades) são documentados em cada página de recurso.
Opções globais e códigos de saída
Todos os verbos uip or respeitam as quatro opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato compartilhado; qualquer substituição específica do verbo é chamada na página do recurso relevante.
Veja também
- Conceitos: como o UiPath CLI é organizado — onde as ferramentas se encaixam no modelo de host + ferramenta.
- Sessões — como o contexto do tenant e da pasta são resolvidos.
- Configuração — variáveis de ambiente e arquivos de configuração que afetam cada ferramenta.
- Início rápido e seu primeiro pipeline — tutoriais completos que usaram
uip or.