UiPath CLI

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

Observação:

A UiPath CLI 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 .

Note: UiPath CLI does not support SSO connection.

Pré-requisitos

• Para o UiPath.CLI, instale o .NET 6.0.7, que vem com o 6.0.302 SDK ou superior.
• Para o UiPath.CLI.Windows, instale o .NET 6.0.7 ou superior. Você também deve instalar o .NET Desktop Runtime, que também vem com o .NET SDK.

Baixando a CLI

É possível baixar qualquer versão do UiPath CLI no Feed Público Oficial da UiPath. Para encontrar a versão correta para seu projeto, revise a matriz de compatibilidade abaixo.

1. Vá para 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.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

Controlling the NuGet feeds used by the CLI

Disabling the built-in NuGet feeds

By default, uipcli searches for dependencies in the following built-in feeds:

• 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(if this path is on the current agent)
• C:\Program Files (x86)\Microsoft SDKs\NuGetPackages (if this path is on the current agent)

You can specify uipcli to not use the built-in feeds by setting the --disableBuiltInNugetFeeds parameter. This parameter can be passed to the following tasks: analyze, pack, and test run.

When you run uipcli with a configuration file, set "disableBuiltInNugetFeeds": true.

Using custom NuGet feeds

You can use custom feeds when packing an automation. To do this, you need to:

1. Create a custom nuget.config file with the following format:

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

2. Place the custom nuget.config file in the folder where uipcli is cached:

   

Using custom nuget.config in Azure DevOps

You need to update the configuration and copy nuget.config to $(Agent.ToolsDirectory)/uipcli, after the InstallPlatform step, as shown in the following example:

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'

Using custom nuget.config in Jenkins

You need to update the configuration and copy nuget.config to ${WORKSPACE}/CLI, after the InstallPlatform step, as shown in the following example:

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