About UiPath CLI

UiPath® ofrece una interfaz de línea de comandos (CLI) que te permite ejecutar ciertas tareas predefinidas para la gestión y prueba de paquetes RPA. El propósito de UiPath CLI es integrar fácilmente esas capacidades con herramientas de terceros como GitLab, Jenkins y muchas otras, sin 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.

• UiPath CLI no se puede utilizar para crear proyectos que utilicen desencadenadores locales.

• La CLI de UiPath carece de la funcionalidad para firmar un paquete, una característica que está disponible cuando se publica el paquete desde Studio. En este caso, la única opción es firmar el paquete después de que se haya creado utilizando la CLI de UiPath. Para obtener más información, consulta el comando firmar. Esta opción de firma también funciona para Azure DevOps y Jenkins.

Requisitos previos

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

CLI version	Versión .NET requerida	Versión de Robot de destino para las automatizaciones creadas
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. Vaya 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 designed for Linux devices
   • UiPath.CLI.Windows - UiPath CLI designed for Windows devices
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

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.

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)

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 fuentes NuGet personalizadas

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