- Visão geral
- Introdução
- Conceitos
- Usando o UiPath CLI
- UiPath para agentes de codificação
- 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
Guia do usuário da UiPath CLI
uip is a ferramenta do Integration Service: gerencia a plataforma do conector que intermedia conexões do OAuth para o SaaS externo e executa atividades CRUD contra elas. A ferramenta é organizada em torno de cinco recursos — conectores (o catálogo), conexões (sessões do OAuth para uma conta), atividades (definições de operação por conector), recursos (objetos de conector e suas operações no plano de dados) e gatilhos (orientados por eventos operações de conector). Instale-o com uip tools install is ou invoque uip is … 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. is é o prefixo do comando; o pacote subjacente é @uipath/integrationservice-tool.
A maioria dos comandos de leitura armazena em cache as respostas por tenant no disco para manter o uso interativo responsivo; passe --refresh em qualquer comando em cache para forçar uma nova busca.
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 is — execute uip is --help para confirmar a superfície completa em sua instalação.
| Recurso | Finalidade |
|---|---|
| Conectores | O catálogo de conectores — cada integração que o tenant pode alcançar. |
| Conexões | Credenciais/sessões do OAuth no lado do tenant para um conector. |
| Atividades | As operações que um conector expõe (CreateTicket, ListAllRecords, etc.). |
| Recursos | Objetos de conector (tíquetes, contatos, arquivos), com describe e runtime execute. |
| Gatilhos | Gatilhos de evento (CREATED, UPDATED, DELETED) que o conector pode disparar. |
Resumo
uip is <resource> <verb> [options]
uip is <resource> <verb> [options]
Sempre uip is, nunca uip integration-service. is é o prefixo de comando da ferramenta (consulte a coluna commandPrefix em uip tools list).
Sinalizadores comuns
Um pequeno conjunto de sinalizadores é recorrente nos verbos do recurso. 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. |
--refresh | verbos de leitura em cache (list, describe, get, objects) | Force uma nova busca a partir da API e atualize o cache no disco. |
--connection-id <id> | Muitos verbos | Escopo uma solicitação para uma conexão. Exigido por todo resources execute ; opcional em leituras de metadados, onde permite que o servidor inclua objetos/campos personalizados. |
Os sinalizadores específicos do verbo (filtros, corpos, parâmetros de consulta) são documentados em cada página de recurso.
Opções globais e códigos de saída
Todos os verbos uip is respeitam as quatro opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato compartilhado.
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 é resolvido.
- Configuração — variáveis de ambiente e arquivos de configuração que afetam cada ferramenta.
uip login— sessão usada para todas as chamadas do Integration Service.