Sobre o UiPath CLI

O UiPath® oferece uma interface de linha de comando (CLI) que permite executar determinadas tarefas pré-definidas para gerenciamento e teste de pacotes RPA. O objetivo do UiPath CLI é integrar facilmente esses recursos com ferramentas de terceiros, como GitLab, Jenkins e muitas outras, sem um plug-in.

Observação:

A CLI da UiPath pode ser usada com o Orchestrator implantado via Automation Cloud™ , Automation Suite ou independente.

Casos de uso comuns para o UiPath CLI envolvem:

• Empacotando projetos do Studio em pacotes NuGet.
• Implantando pacotes NuGet no Orchestrator.
• Executando trabalhos no Orchestrator.
• Executando conjuntos de testes no Orchestrator.

O UiPath CLI consiste em dois tipos:

1. UiPath.CLI.Windows

   • Funciona apenas em dispositivos Windows.
   • Constrói projetos Windows - legados,Windowse multiplataforma .

2. UiPath.CLI

   • É executado apenas em dispositivos Linux.
   • Constrói apenas projetos de plataforma cruzada .

Observação:

• A UiPath CLI não é compatível com conexão SSO.

• A UiPath CLI não pode ser usada para criar projetos que usam Gatilhos locais.

• O UiPath CLI não tem a funcionalidade para assinar um pacote, um recurso que está disponível ao publicar o pacote do Studio. Nesse caso, a única opção é assinar o pacote após ele ser criado usando o UiPath CLI. Para obter detalhes, consulte o comando assinar. Essa opção de assinatura também funciona para o Azure DevOps e Jenkins.

Pré-requisitos

Aqui você pode verificar a compatibilidade entre a versão da CLI, a versão do .NET necessária e a versão do Robot de destino.

Versão da CLI	Versão do .NET necessária	Versão do Robot de destino para as automações criadas
24.10	.NET 8	2024.10+
23.10	.NET 6	2023.10+
23.4	.NET 6	2023.4+

Para o UiPath.CLI.Windows, você também deve instalar o .NET Desktop Runtime, que também vem com o .NET SDK.

Baixando o UiPath CLI

Você pode baixar qualquer versão do UiPath CLI no Feed Público Oficial da UiPath.

1. Acesse o feed público oficial da UiPath.
2. Na barra de pesquisa Filtrar por palavras-chave , digite uipath.cli.
3. Selecione uma das opções abaixo:
   • UiPath.CLI - UiPath CLI projetado para dispositivos Linux
   • UiPath.CLI.Windows - UiPath CLI projetado para dispositivos Windows
4. Vá para a guia Versões e selecione uma versão da CLI que deseja baixar.
5. Selecione Baixar.
6. Abra a pasta onde o arquivo NUPKG foi baixado, clique com o botão direito do mouse e extraia o arquivo em uma pasta.

Resultados: Uma pasta com o mesmo nome do arquivo NUPKG é criada. Esta pasta contém o conteúdo do UiPath CLI. O ponto de entrada para todas as operações é uipcli.exe (para UiPath.CLI.Windows) ou uipcli.dll (para UiPath.CLI), localizado na pasta tools .

Matriz de Compatibilidade UiPath.CLI.Windows

A versão do UiPath Studio que você está usando para criar seus projetos precisa corresponder à versão do UiPath.CLI.Windows.

Legenda: - compatível; - não compatível.

Orchestrator	Tipo de Projeto	UiPath.CLI.Windows 23.10	UiPath.CLI.Windows 23.6	UiPath.CLI.Windows 22.10
2023.10.x PaaS	Windows - Legacy
2023.10.x PaaS	Windows
2023.10.x PaaS	Multiplataforma
2021.10.x On-Premises	Windows - Legacy
2021.10.x On-Premises	Windows
2021.10.x On-Premises	Multiplataforma
2021.10.x PaaS	Windows - Legacy
2021.10.x PaaS	Windows
2021.10.x PaaS	Multiplataforma
2022.4.x	Windows - Legacy
2022.4.x	Windows
2022.4.x	Multiplataforma
2022.10.x	Windows - Legacy
2022.10.x	Windows
2022.10.x	Multiplataforma
2023.4.x	Windows-legacy
2023.4.x	Windows
2023.4.x	Multiplataforma
Cloud	Windows - Legacy
Cloud	Windows
Cloud	Multiplataforma

Matriz de Compatibilidade UiPath.CLI

A versão do UiPath Studio que você está usando para criar seus projetos precisa corresponder à versão do UiPath.CLI. Por exemplo, se você criar projetos usando o UiPath Studio 2021.10, você precisa usar a versão 21.10 do UiPath.CLI.

Legenda: - compatível; - não compatível.

Orchestrator	Tipo de Projeto	UiPath.CLI 23.10	UiPath.CLI 23.6	UiPath.CLI 22.10	UiPath.CLI 22.4	UiPath.CLI 21.10
2023.10.x PaaS	Windows - Legacy
2023.10.x PaaS	Windows
2023.10.x PaaS	Multiplataforma
2021.10.x On-Premises	Windows - Legacy
2021.10.x On-Premises	Windows
2021.10.x On-Premises	Multiplataforma
2021.10.x PaaS	Windows - Legacy
2021.10.x PaaS	Windows
2021.10.x PaaS	Multiplataforma
2022.4.x	Windows - Legacy
2022.4.x	Windows
2022.4.x	Multiplataforma
2022.10.x	Windows - Legacy
2022.10.x	Windows
2022.10.x	Multiplataforma
2023.4.x	Windows-legacy
2023.4.x	Windows
2023.4.x	Multiplataforma
Cloud	Windows - Legacy
Cloud	Windows
Cloud	Multiplataforma

Gerenciando feeds do NuGet

Esta seção descreve como você pode gerenciar os feeds integrados do NuGet. Além disso, ele fornece informações sobre como você pode usar feeds personalizados do NuGet de acordo com seus requisitos específicos do projeto.

Desabilitando os feeds integrados do NuGet

Por padrão, o uipcli pesquisa dependências nos seguintes feeds integrados:

• https://pkgs.dev.azure.com/uipath/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json

• https://gallery.uipath.com/api/v2

• https://api.nuget.org/v3/index.json

• C:\Program Files\Microsoft SDKs\NuGetPackages(se este caminho estiver no agente atual)
• C:\Program Files (x86)\Microsoft SDKs\NuGetPackages (se este caminho estiver no agente atual)

Você pode especificar uipcli para não usar os feeds integrados definindo o parâmetro --disableBuiltInNugetFeeds . Esse parâmetro pode ser usado para as seguintes tarefas: analyze, pack e test run.Ao executar uipcli com um arquivo de configuração, defina "disableBuiltInNugetFeeds": true.

Uso de feeds personalizados do NuGet

Você pode usar feeds personalizados ao empacotar uma automação.

Usando o nuget.config personalizado no UiPath CLI

Para usar o feed personalizado, siga as seguintes etapas:

1. Crie um arquivo nuget.config personalizado com o seguinte formato:

    <?xml version="1.0" encoding="utf-8"?>
   <configuration>
     <packageSources>
       <add key="test custom feed" value="custom_feed_url" />
     </packageSources>
   </configuration>

2. Coloque o arquivo nuget.config personalizado na pasta em que uipcli está em cache:

   

Uso do nuget.config personalizado no Azure DevOps

Você precisa atualizar a configuração e copiar nuget.config para $(Agent.ToolsDirectory)/uipcli, após a etapa InstallPlatform , conforme mostrado no exemplo a seguir:

 trigger:
- main

pool:
  vmImage: ubuntu-latest

stages:
- stage: Demo
  jobs:
    - job: Demo
      steps:
        - task: UiPathInstallPlatform@4
          inputs:
            cliVersion: 'X_23.6.8581.19168'
        
        - task: CopyFiles@2
          inputs:
            SourceFolder: '$(Build.SourcesDirectory)'
            Contents: 'nuget.config'
            TargetFolder: '$(Agent.ToolsDirectory)/uipcli'

        - task: UiPathPack@4
          inputs:
            versionType: 'AutoVersion'
            projectJsonPath: '$(Build.SourcesDirectory)/AutomationProjects/CrossPlatform/VB/ProjectWithCustomLibraryFromOrchestrator_CrossPlatform_VB/project.json'
            outputPath: '$(Build.ArtifactStagingDirectory)/Output'
            traceLevel: 'Information'

Usando o nuget.config personalizado no Jenkins

Você precisa atualizar a configuração e copiar nuget.config para ${WORKSPACE}/CLI, após a etapa InstallPlatform , conforme mostrado no exemplo a seguir:

 pipeline {
    agent {
        label 'plugins-jenkins-lts-agent-01'
    }

    stages {
        stage('Clone') {
            steps {
                git (
                    branch: 'main',
                    url: 'https://github.com/al3xandru-uipath-qa/CI-Plugins-Customer-Support.git'
                )
            }
        }
        
        stage('Install Platform') {
            steps {
                UiPathInstallPlatform (
                    traceLevel: 'Information'
                )
            }
        }
        
        stage('Copy nuget.config') {
            steps {
                bat 'copy nuget.config CLI\\nuget.config'
            }
        }
        
        stage('Pack') {
            steps {
                UiPathPack (
                    outputPath: '${WORKSPACE}/Output',
                    projectJsonPath: '${WORKSPACE}/AutomationProjects/CrossPlatform/VB/ProjectWithCustomLibraryFromOrchestrator_CrossPlatform_VB/project.json',
                    traceLevel: 'Information',
                    version: AutoVersion()
                )
            }
        }
    }
}

Recuperação de dependências de automação para ambientes isolados

Esta seção orienta você sobre como obter as dependências de automação ao planejar a transição de um ambiente online para um offline isolado. Se uma automação usar bibliotecas personalizadas, elas precisam ser transferidas manualmente para o ambiente de destino.

O UiPath CLI fornece uma maneira automatizada de proteger os pacotes de dependência do NuGet e carregá-los para o ambiente de destino.

Antes de prosseguir, certifique-se de atender aos seguintes pré-requisitos:

• Certifique-se de usar a versão mais recente do UiPath CLI (pelo menos 24.12).

• Se aplicável, certifique-se de instalar o .NET 8.

• Crie um aplicativo externo com os seguintes escopos do aplicativo (NÃO escopos do usuário):

   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

  Para obter mais detalhes sobre a configuração do aplicativo externo, consulte Automation Ops — Execução de tarefas.

Com os pré-requisitos implementados, siga estas etapas para facilitar a transição de suas dependências de automação para um ambiente offline isolado:

1. Use o comando restore . Você deve fornecer a pasta do projeto, o local para downloads de dependência e informações de autenticação segura para acessar o feed da biblioteca do Orchestrator, conforme mostrado no exemplo a seguir:

    uipcli package restore "C:\Users\Test_User\OneDrive - UiPath\Documents\UiPath\MathAutomation" --restoreFolder "C:\restoredPackages" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TENANT_NAME"  -A "ORGANIZATION_NAME" -I "EXTERNAL_APPLICATION_ID" -S "EXTERNAL_APPLICATION_SECRET" --libraryOrchestratorApplicationScope "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"

   Importante:

   Esteja ciente de que se mesmo um pacote do feed do tenant não puder ser obtido, nenhum pacote será baixado.

2. Use o comando deploy . Esse comando carrega os pacotes no feed da biblioteca do tenant.

   Você deve fornecer a pasta que contém os pacotes NuGet e os detalhes de autenticação para o feed da biblioteca do Orchestrator, conforme mostrado no exemplo a seguir:

    uipcli.exe package deploy "C:\restoredPackages" "https://alpha.uipath.com/" "TENANT_NAME"  -A "ORGANIZATION_NAME" -I "EXTERNAL_APPLICATION_ID" -S "EXTERNAL_APPLICATION_SECRET" --applicationScope "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" -o "BusStop" --ignoreLibraryDeployConflict

   Durante a execução do comando deploy , você pode encontrar uma mensagem de erro de tarefa cancelada, conforme mostrado no exemplo a seguir:

    System.Threading.Tasks.TaskCanceledException: A task was canceled.
      at System.Threading.Tasks.Task.GetExceptions(Boolean includeTaskCanceledExceptions)
      at System.Threading.Tasks.Task`1.GetResultCore(Boolean waitCompletionNotification)
      at UiPath.CommandLine.Core.AppRunner.Run(String[] args, Func`2 containerBuilderFactory) in C:\ao-ag-eb2c89c4-we\_work\1\s\UiPath.Extensions.CommandLine.Core\AppRunner.cs:line 23
      at UiPath.CommandLine.Program.Main(String[] args) in C:\ao-ag-eb2c89c4-we\_work\1\s\UiPath.Extensions.CommandLine\Program.cs:line 10
   --- End of stack trace from previous location ---
   
   
   An error was encountered. Please check if everything was configured correctly by visiting https://docs.uipath.com/automation-ops/automation-cloud/latest/user-guide/uipath-command-line-interface

   Se você encontrar esse erro, tente executar o comando novamente. Normalmente, o comando funciona na segunda tentativa.