CLI de Uipath

UiPath ofrece una interfaz de línea de comandos (CLI) que te permite ejecutar ciertas tareas predefinidas para la administración y prueba de paquetes RPA. El propósito de la CLI de UiPath es integrar fácilmente esas capacidades con herramientas de terceros como GitLab, Jenkins y muchas otras, sin necesidad de un complemento.

Nota:

La CLI de UiPath se puede utilizar con Orchestrator implementado a través de Automation Cloud, Automation Suite o de forma independiente.

Los casos de uso comunes para la CLI de UiPath incluyen:

• Empaquetar proyectos de Studio en paquetes NuGet.
• Implementar paquetes NuGet en Orchestrator.
• Ejecutar trabajos en Orchestrator.
• Ejecutar conjuntos de prueba en Orchestrator.

La CLI de UiPath consta de dos tipos:

1. UiPath.CLI.Windows

   • Solo se ejecuta en dispositivos Windows.
   • Crea proyectos de Windows: heredados,Windowsy multiplataforma .

2. UiPath.CLI

   • Solo se ejecuta en dispositivos Linux.
   • Crea solo proyectos multiplataforma .

Nota: UiPath CLI no admite la conexión SSO.

Requisitos previos

• Para UiPath.CLI, instala .NET 6.0.7, que viene con el SDK 6.0.302 o posterior.
• Para UiPath.CLI.Windows, instala .NET 6.0.7o superior. También debes instalar .NET Desktop Runtime, que también viene con el SDK de .NET.

Descargar la CLI

Puedes descargar cualquier versión de UiPath CLI desde la fuente pública oficial de UiPath; para encontrar la versión correcta para tu proyecto, revisa la siguiente matriz de compatibilidad.

1. Ve a la fuente pública oficial de UiPath.
2. En la barra de búsqueda de Filtrar por palabras clave , escribe uipath.cli.
3. Seleccione una de las siguientes opciones:
   • UiPath.CLI
   • UiPath.CLI.Windows
4. Ve a la pestaña Versiones y selecciona la versión de la CLI que deseas descargar.
5. Selecciona Descargar.
6. Abra la carpeta donde se descarga el archivo NUPKG, haga clic con el botón derecho y extraiga el archivo en una carpeta.

Resultados: se crea una carpeta con el mismo nombre que el archivo NUPK. Esta carpeta contiene el contenido de la CLI de UiPath. El punto de entrada para todas las operaciones es uipcli.exe (para UiPath.CLI.Windows) o uipcli.dll (para UiPath.CLI), ubicado en la carpeta tools .

Matriz de compatibilidad de UiPath.CLI.Windows

La versión de UiPath Studio que utilice para crear sus proyectos debe coincidir con la versión de UiPath.CLI.Windows.

Leyenda: - compatible; : no compatible.

Orchestrator	Tipo de proyecto	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	Ventanas
2023.10.x PaaS	Multiplataforma
2021.10.x En las instalaciones	Windows: Legacy
2021.10.x En las instalaciones	Ventanas
2021.10.x En las instalaciones	Multiplataforma
2021.10.x PaaS	Windows: Legacy
2021.10.x PaaS	Ventanas
2021.10.x PaaS	Multiplataforma
2022.4.x	Windows: Legacy
2022.4.x	Ventanas
2022.4.x	Multiplataforma
2022.10.x	Windows: Legacy
2022.10.x	Ventanas
2022.10.x	Multiplataforma
2023.4.x	Windows: Legacy
2023.4.x	Ventanas
2023.4.x	Multiplataforma
Nube	Windows: Legacy
Nube	Ventanas
Nube	Multiplataforma

Matriz de compatibilidad UiPath.CLI

La versión de UiPath Studio que utilice para crear sus proyectos debe coincidir con la versión de UiPath.CLI. Por ejemplo, si crea proyectos con UiPath Studio 2021.10, debe utilizar la versión 21.10 de UiPath.CLI.

Leyenda: - compatible; : no compatible.

Orchestrator	Tipo de proyecto	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	Ventanas
2023.10.x PaaS	Multiplataforma
2021.10.x En las instalaciones	Windows: Legacy
2021.10.x En las instalaciones	Ventanas
2021.10.x En las instalaciones	Multiplataforma
2021.10.x PaaS	Windows: Legacy
2021.10.x PaaS	Ventanas
2021.10.x PaaS	Multiplataforma
2022.4.x	Windows: Legacy
2022.4.x	Ventanas
2022.4.x	Multiplataforma
2022.10.x	Windows: Legacy
2022.10.x	Ventanas
2022.10.x	Multiplataforma
2023.4.x	Windows: Legacy
2023.4.x	Ventanas
2023.4.x	Multiplataforma
Nube	Windows: Legacy
Nube	Ventanas
Nube	Multiplataforma

Controlar las fuentes NuGet utilizadas por la CLI

Deshabilitar las fuentes NuGet integradas

De forma predeterminada, uipcli busca dependencias en las siguientes fuentes integradas:

• 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(si esta ruta está en el agente actual)
• C:\Program Files (x86)\Microsoft SDKs\NuGetPackages (si esta ruta está en el agente actual)

Puedes especificar que uipcli no utilice las fuentes integradas estableciendo el parámetro --disableBuiltInNugetFeeds . Este parámetro se puede pasar a las siguientes tareas: analyze, pack y test run.

Cuando ejecutes uipcli con un archivo de configuración, establece "disableBuiltInNugetFeeds": true.

Uso de fuentes NuGet personalizadas

Puedes utilizar fuentes personalizadas al empaquetar una automatización. Para ello, es necesario:

1. Crea un archivo nuget.config personalizado con el siguiente formato:

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

2. Coloca el archivo nuget.config personalizado en la carpeta donde se almacena uipcli :

   

Uso de nuget.config personalizado en Azure DevOps

Debes actualizar la configuración y copiar nuget.config a $(Agent.ToolsDirectory)/uipcli, después del paso InstallPlatform , como se muestra en el siguiente ejemplo:

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'

Uso de nuget.config personalizado en Jenkins

Debes actualizar la configuración y copiar nuget.config a ${WORKSPACE}/CLI, después del paso InstallPlatform , como se muestra en el siguiente ejemplo:

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