- 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
Prerequisites:
- Criar um projeto
- Execute o arquivo CLI
exe(para Windows Legacy) oudll(para Windows/Linux/macOS). - Adicione os escopos de aplicativos de acesso à API do Orchestrator necessários.
Para analisar um projeto, siga as seguintes etapas:
- Execute a tarefa
package, usandouipcli package. Você pode ver uma lista das subtarefas disponíveis. - Especifique os parâmetros necessários e execute a subtarefa
analyze. A tabela a seguir descreve os parâmetros necessários.
Project validation runs as part of the analyze task and cannot be skipped. Validation messages are surfaced alongside Workflow Analyzer messages in the analyzer output.
Legenda: (*) - Opcional, recomendado ao usar feeds de pacote adicionais.
| Parâmetro | Description |
|---|---|
Project(s) Path (pos. 0) ( Necessário ) | O caminho para o arquivo project.json ou o caminho para a pasta que contém vários arquivos project.json . |
|
| Escolha quais tipos de mensagens enviar após a análise:
|
|
| O trabalho falha quando alguma regra é violada. |
|
| Trate os avisos como erros. |
|
| O caminho completo para um arquivo JSON no qual você deseja armazenar os resultados. Se você não adicionar isso como um argumento, os resultados serão impressos apenas no console padrão. |
|
| Aprovar políticas de governança que contenham as regras do Analisador de Fluxo de Trabalho. As políticas podem ser baixadas de ou extraídas do arquivo zip compactado exportado do Studio . A tarefa falha se você especificar o uso de uma política, mas o arquivo da política não estiver no caminho mencionado. |
|
| Uma lista de regras que você deseja ignorar durante a análise, separadas por vírgulas. |
-u , --orchestratorUsername (*) (Necessário se você usar a Autenticação básica, por meio de um nome de usuário e uma senha) | O nome de usuário usado para autenticação no Orchestrator. Você deve emparelhá-lo com a senha correspondente. |
-p , --orchestratorPassword (*) (Necessário se você usar a Autenticação básica, por meio de um nome de usuário e uma senha) | A senha usada para autenticação ao Orchestrator. Você deve combiná-lo com o nome de usuário correspondente. |
-t , -orchestratorAuthToken (*) (Obrigatório se você usar a autenticação baseada em token) | O token de atualização do OAuth2 usado para autenticação ao Orchestrator. Você deve combiná-lo com o Nome da conta e ID do cliente . |
-a , --orchestratorAccountName (*) (Obrigatório se você usar a autenticação baseada em token) | O nome da conta CloudRPA do Orchestrator. Você deve combiná-lo com o token de atualização do OAuth2 e o ID do cliente . |
-A , --orchestratorAccountForApp (*) | O nome da conta do Orchestrator CloudRPA (nome da organização). Você deve combiná-lo com a ID do aplicativo, Segredo do aplicativo e Escopo do aplicativo para um aplicativo externo. |
-I , --orchestratorApplicationId (*) ( Necessário se você usar autenticação de aplicativo externo ) | A ID do aplicativo externo. Você deve combiná-lo com a **Conta do aplicativo, Segredo do aplicativo e Escopo do aplicativo. |
-S , --orchestratorApplicationSecret (*) ( Necessário se você usar autenticação de aplicativo externo ) | O Segredo do aplicativo externo. Você deve combiná-lo com a Conta do aplicativo, ID do aplicativo e Escopo do aplicativo. |
--orchestratorApplicationScope (*) ( Opcional para autenticação de aplicativos externos ) | A lista de escopos do aplicativo, separada por espaços únicos. Opcional ao usar autenticação de aplicativo externo, pois os escopos padrão são aplicados automaticamente. Você deve combiná-lo com a Conta do aplicativo , ID do aplicativo e Segredo do aplicativo para um aplicativo externo. |
--orchestratorFolder (*) | O nome da pasta de destino do Orchestrator. AccountingTeam\TeamJohn. |
--orchestratorUrl (*) | O URL da instância do Orchestrator. |
--orchestratorTenant (*) | O tenant da instância do Orchestrator. |
-l , --language | A linguagem do Orchestrator. |
|
| Exibir o rastreamento dos eventos. |
--identityUrl | The URL of your identity server. Required when the Orchestrator runs on UiPath Automation Suite or standalone Orchestrator (on-premises MSI). Not needed for Automation Cloud — the CLI resolves the identity server from the cloud URL. |
|
| Caminho para o arquivo NuGet.Config que contém os feeds. A tag |
|
| Desabilitar feeds integrados do NuGet. |
|
| Excludes the built-in feeds and the NuGet sources configured at the user and machine level on the host running the CLI. The CLI resolves packages only from the feeds defined in |
--ca-cert | Um ou mais arquivos de certificado de CA raiz confiáveis (pem, 5 ou PKCS#7DER) usados ao validar os certificados TLS do Orchestrator e do Identity Server. Repete o sinalizador ou vários caminhos separados por vírgulas. Consulte Confiança em certificados personalizados para obter mais detalhes. |
--pinnedpubkey | Fixe a chave pública do certificado leaf do servidor. Formato: sha256//<base64>. Verificado além da validação de certificado padrão. Consulte Confiança em certificados personalizados para obter mais detalhes. |
Para instâncias do Orchestrator assinadas por uma Autoridade de Certificação privada (como o UiPath Automation Suite), esse comando também aceita parâmetros --ca-cert e --pinnedpubkey . Consulte Confiança em certificados personalizados para cenários e exemplos.
Ao usar a autenticação de aplicativos externos sem especificar o parâmetro --orchestratorApplicationScope , a CLI aplica automaticamente esses escopos do Orchestrator padrão:
OR.Assets OR.BackgroundTasks OR.Execution OR.Folders OR.Robots.Read OR.Machines.Read OR.Jobs OR.TestSets OR.TestSetExecutions OR.Monitoring OR.Settings.Read
Uso:
uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds] [--excludeConfiguredSources]
uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds] [--excludeConfiguredSources]
Exemplos mínimos de comandos:
uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json"uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S '********' --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://automation-suite.base.url.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S '********' --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName"uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://cloud.uipath.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S '********' --orchestratorApplicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --orchestratorFolder "FolderName"