- Visão geral
- UiPath CLI
- Sobre o UiPath CLI
- Baixando o UiPath CLI
- Matriz de compatibilidade
- Executando o UiPath CLI
- Gerenciando feeds do NuGet
- Confiança em certificados personalizados
- Suporte do Test Manager
- Empacotando projetos em um pacote
- Assinatura de pacotes de projetos
- Análise de um projeto
- Implantação de um pacote no Orchestrator
- Executando um trabalho dentro do Orchestrator
- Teste de um pacote ou execução de um conjunto de testes
- Teste de vários pacotes
- Formato JSON dos parâmetros de entrada
- Implantação de ativos no Orchestrator
- Exclusão de ativos do Orchestrator
- Executando tarefas usando a configuração JSON
- Restaurando dependências de automação
- Solução de problemas do UiPath CLI
- Extensão do Azure DevOps
- Plug-in do Jenkins
Guia do usuário de integrações de CI/CD
Todos os comandos de solução exigem autenticação por meio de um aplicativo externo configurado no Orchestrator. Ao contrário das tarefas de projeto independentes, as soluções não são compatíveis com métodos de autenticação de máquina ou interativos.
Requisitos de autenticação
Os comandos de soluções autenticam-se exclusivamente por meio do OAuth2 com Apps externos.
Você deve configurar um aplicativo externo no Administrador do Orchestrator com os escopos apropriados antes de executar qualquer comando do Solution CLI.
Escopos do OAuth exigidos
As soluções usam um conjunto dedicado de escopos de aplicativos que diferem dos escopos padrão do Orchestrator. Configure seu aplicativo externo com os seguintes escopos para todas as operações de solução:
Formato copiar-colar para segredos do CI/CD:
AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write
AutomationSolutions Solutions.Deployments Solutions.Deployments.Read Solutions.Deployments.Write Solutions.Packages Solutions.Packages.Read Solutions.Packages.Write
Esse formato de linha única separado por espaço pode ser usado diretamente em:
- Grupos de variáveis do Azure DevOps
- Segredos do repositório do GitHub
- Armazenamento de credenciais do Jenkins
Observação: as seguintes operações não exigem autenticação, pois são executadas localmente:
restore- Restaura dependências localmenteanalyze- Valida projetos localmentepack- Cria pacotes localmente
Parâmetros de autenticação comuns
Todos os comandos de solução que interagem com o Orchestrator exigem esses parâmetros. Você pode usar o formulário curto ou o formulário longo (alternativa) para cada um:
| Formulário curto | Formato longo (alternativa) | Description | Exemplo |
|---|---|---|---|
-U | N/A | URL do Orchestrator | Consulte o URL do Orchestrator abaixo |
-T | N/A | Nome do tenant do Orchestrator | DefaultTenant |
-A | --accountForApp | Nome da organização (conta) | myorg |
-I | --applicationId | ID do aplicativo externo | 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
-S | --applicationSecret | Segredo do aplicativo externo | **** (manter seguro) |
--applicationScope | N/A | Lista de escopo (ver acima) | Acima |
--traceLevel | N/A | Nível de Registros de Log | Information, Verbose, Warning |
Exemplo com parâmetros de formato longo:
uipcli solution upload-package ./packages/MySolution.1.0.0.zip \
-U https://cloud.uipath.com/ \
-T DefaultTenant \
--accountForApp myorg \
--applicationId 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
--applicationSecret **** \
--applicationScope "AutomationSolutions Solutions.Packages Solutions.Packages.Write"
uipcli solution upload-package ./packages/MySolution.1.0.0.zip \
-U https://cloud.uipath.com/ \
-T DefaultTenant \
--accountForApp myorg \
--applicationId 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
--applicationSecret **** \
--applicationScope "AutomationSolutions Solutions.Packages Solutions.Packages.Write"
URL do Orchestrator
Use a URL de base apenas para a instância do Orchestrator. Não inclua segmentos de organização, tenant ou caminho (por exemplo, não use https://cloud.uipath.com/myorg/DefaultTenant/orchestrator_). Organização e tenant são passados separadamente com -A e -T.
- UiPath Automation Cloud: use a URL base da nuvem (por exemplo,
https://cloud.uipath.com/ouhttps://staging.uipath.com/). - Automation Suite (local ou nuvem privada): use a URL base de sua instância do Automation Suite (por exemplo
https://uipath.yourcompany.com/). A URL é a mesma que para os comandos do pacote. Apenas o endereço base do seu Orchestrator (ou Automation Suite) difere da nuvem pública.
Ao usar a autenticação de aplicativos externos sem especificar o parâmetro --applicationScope , a CLI aplica automaticamente os escopos necessários para comandos de Solução.
Como configurar um aplicativo externo
Para criar um aplicativo externo para soluções:
- Faça login no Orchestrator como administrador. . Administr
- Navegue até Administrador → Aplicativos externos.
- Clique em Adicionar aplicativo.
- Forneça um nome (por exemplo,
CI-CD-Solutions). - Selecione Aplicativo confidencial como o Tipo de aplicativo.
- Adicione os escopos necessários listados acima.
- Copie o ID do aplicativo e o Segredo e armazene-os com segurança no seu gerenciador de segredo do CI/CD.
Para obter instruções detalhadas sobre como configurar aplicativos externos, consulte Gerenciamento de aplicativos externos do OAuth.
Uso de feeds personalizados do Orchestrator
Ao usar feeds de atividades personalizados do Orchestrator durante as operações de restauração, use estes parâmetros alternativos:
| Parâmetro padrão | Parâmetro de Feed Personalizado |
|---|---|
--applicationScope | --libraryOrchestratorApplicationScope |
-T (tenant) | --libraryOrchestratorTenant |
-U (URL) | --libraryOrchestratorUrl |
| (pasta) | --libraryOrchestratorFolder |
Exemplo:
uipcli solution restore <solution-path> \
-A myorg \
-I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
-S **** \
--libraryOrchestratorApplicationScope "OR.Folders OR.Settings.Read" \
--libraryOrchestratorTenant DefaultTenant \
--libraryOrchestratorUrl https://cloud.uipath.com/ \
--libraryOrchestratorFolder MyFolder
uipcli solution restore <solution-path> \
-A myorg \
-I 12345678-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
-S **** \
--libraryOrchestratorApplicationScope "OR.Folders OR.Settings.Read" \
--libraryOrchestratorTenant DefaultTenant \
--libraryOrchestratorUrl https://cloud.uipath.com/ \
--libraryOrchestratorFolder MyFolder
Melhores práticas de segurança
- Nunca codificar segredos no pipeline YAML ou scripts.
- Use o gerenciamento de segredos da sua plataforma de CI/CD:
- Azure DevOps: grupos de variáveis com variáveis secretas.
- Actions do GitHub: segredos do repositório ou da organização.
- Jenkins: Armazenamento de credenciais.
- Faça a rotação de segredos de aplicativos externos regularmente.
- Use aplicativos externos separados para diferentes ambientes (Dev, Test, Prod).
- Aplique escopos de privilégio mínimo — conceda apenas o que for necessário para cada pipeline.