About 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

Here you can verify the compatibility between the CLI version, the required .NET version, and the target Robot version.

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

For UiPath.CLI.Windows, you must also install .NET Desktop Runtime, that comes with the .NET SDK as well.

Downloading UiPath CLI

You can download any version of the UiPath CLI from the UiPath Official Public Feed.

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 designed for Linux devices
   • UiPath.CLI.Windows - UiPath CLI designed for Windows devices
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

Managing NuGet feeds

This section describes how you can manage the build-in NuGet feeds. Moreover, it provides information on how you can use custom NuGet feeds according to your specific project requirements.

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)

You can specify uipcli to not use the built-in feeds by setting the --disableBuiltInNugetFeeds parameter. This parameter can be used to the following tasks: analyze, pack, and test run.When you run uipcli with a configuration file, set "disableBuiltInNugetFeeds": true.

Uso de feeds personalizados do NuGet

You can use custom feeds when packing an automation.

Using custom nuget.config in UiPath CLI

To use custom feed, take the following steps:

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()
                )
            }
        }
    }
}