Herramientas de UIP

uip tools las herramientas instalables que amplían la CLI. Consulta Herramientas (complementos) para conocer el concepto.

Para saber cómo controlar la instalación automática en los ejecutores CI, consulta Control de la instalación automática de la herramienta.

Sinopsis

uip tools list
uip tools search [<query>]
uip tools install <package-spec>
uip tools update [--name <package>] [--version <version>]
uip tools uninstall <package>

Todos los subcomandos uip tools respetan las opciones globales (--output, --output-filter, --log-level, --log-file). Los códigos de salida siguen el contrato estándar.

lista de herramientas de uip

Enumera las herramientas instaladas actualmente junto con la CLI.

Argumentos

Nada.

Opciones

Nada.

Ejemplo

uip tools list --output table

Data shape (--output json)

{
  "Code": "ToolList",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "version": "1.0.2",
      "commandPrefix": "or"
    },
    {
      "name": "@uipath/solution-tool",
      "version": "1.0.1",
      "commandPrefix": "solution"
    }
  ]
}

commandPrefix es el alias de nivel superior que escribes, por ejemplo, or para Orchestrator. Úsalo para confirmar qué se ejecutará realmente uip <prefix> … .

Búsqueda de herramientas UIP

Busca en el catálogo de herramientas de UiPath las herramientas que puedes instalar. Los resultados se filtran a las herramientas @uipath/ en la lista blanca (incluidas flow y rpa-legacy, que requieren una instalación explícita). Los paquetes de terceros no se devuelven.

Argumentos

• <query> (opcional) : coincidencia de subcadena con el nombre y la descripción del paquete. Sin ella, se enumeran todas las herramientas de la lista blanca.

Opciones

Nada.

Ejemplo

uip tools search orchestrator

Data shape (--output json)

{
  "Code": "SearchResult",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "latestVersion": "1.0.2",
      "description": "Orchestrator jobs, folders, processes, packages, and resources",
      "availableVersions": ["1.0.0", "1.0.1", "1.0.2"]
    }
  ]
}

Buscar lecturas desde el registro npm configurado para el ámbito @uipath (normalmente https://registry.npmjs.org/ a través de la configuración predeterminada de npm o un registro anulado establecido en tu .npmrc). Los resultados se filtran del lado del cliente contra la lista blanca, por lo que se omite cualquier paquete @uipath/ que no esté en la lista blanca.

Instalación de herramientas de UIP

Instala una herramienta en la lista blanca desde npm.

Argumentos

• <package-spec> (obligatorio) : la herramienta a instalar. Cualquiera de:
  • Alias de comando: or, solution, tm, is, vss, df, …
  • Nombre corto: orchestrator-tool, solution-tool, …
  • Nombre completo de npm: @uipath/orchestrator-tool, @uipath/solution-tool, …
  • Con versión explícita: orchestrator-tool@1.0.2, @uipath/orchestrator-tool@1.0.2, orchestrator-tool@beta.

Opciones

Nada.

Ejemplos

# by alias — simplest
uip tools install or

# by short name
uip tools install orchestrator-tool

# by full npm name
uip tools install @uipath/orchestrator-tool

# specific version
uip tools install orchestrator-tool@1.0.2

# preview channel (npm dist-tag)
uip tools install orchestrator-tool@beta

Version resolution

• Con una versión explícita (@1.0.2 o @beta), esa versión se utiliza tal cual.
• Sin una versión, el host selecciona la última versión publicada que coincida con la línea MAYOR.MINOR actual de CLI, por lo que CLI 1.0.x instala la herramienta 1.0.*. Esto mantiene el host y la herramienta compatibles con el protocolo. Consulta Control de versiones y estabilidad.

Destino de instalación: la herramienta se instala junto al paquete npm de CLI: globalmente si CLI es una instalación global, localmente si CLI es una instalación de ámbito de proyecto. No pasas un marcador de ámbito. Ejecuta npm root -g para encontrar la ruta de instalación global en tu máquina.

Aplicación de la lista blanca: <package-spec> debe resolverse en uno de los paquetes @uipath/ de la lista blanca (o rpa-legacy). Cualquier otro valor falla con ValidationError y el código de salida 3: las herramientas de terceros no son compatibles con 1.x.

Data shape (--output json)

{
  "Code": "Message",
  "Data": { "Message": "Successfully installed @uipath/orchestrator-tool@1.0.2" }
}

actualización de herramientas de UIP

Actualiza una o más herramientas instaladas a la última versión compatible.

Argumentos

Nada.

Opciones

• --name <package> : actualiza una sola herramienta. Acepta alias, nombre corto o nombre completo de npm. Sin --name, se actualizan todas las herramientas instaladas.
• --version <version> : versión de destino. El valor predeterminado es latest, que se resuelve de la misma manera que install (anclado a la línea MAYOR.MENOR de CLI). Pase una versión exacta (1.0.3) o una etiqueta de distancia (beta) para anular.

Ejemplos

# update every installed tool to the latest version within the CLI's major.minor line
uip tools update

# update just the Orchestrator tool
uip tools update --name or

# pin a specific tool to an exact version
uip tools update --name orchestrator-tool --version 1.0.3

# switch a tool to a preview channel
uip tools update --name flow-tool --version beta

Data shape (--output json)

{
  "Code": "UpdateResult",
  "Data": [
    {
      "name": "@uipath/orchestrator-tool",
      "status": "updated",
      "from": "1.0.1",
      "to": "1.0.2"
    },
    {
      "name": "@uipath/solution-tool",
      "status": "up-to-date",
      "from": "1.0.1",
      "to": "1.0.1"
    }
  ]
}

Los resultados por herramienta siempre se emiten, incluso en caso de fallo parcial. Si alguna herramienta no se actualiza, el comando sale con un código de salida distinto de cero y las entradas que fallan llevan un campo error .

Desinstalación de herramientas UIP

Elimina una herramienta instalada.

Argumentos

• <package> obligatorio) : alias, nombre corto o nombre completo de npm.

Opciones

Nada.

Ejemplos

uip tools uninstall or
uip tools uninstall @uipath/solution-tool

Data shape (--output json)

{
  "Code": "Message",
  "Data": { "Message": "Successfully uninstalled @uipath/orchestrator-tool" }
}

Después de la desinstalación, al invocar uip or … se instalará automáticamente la herramienta Orchestrator de nuevo en el próximo uso, a menos que la instalación automática esté bloqueada (por ejemplo, en un ejecutor sin acceso a la red). Instala explícitamente para evitar eso.

Códigos de salida

• 0 : correcto.
• 1 — fallo (instalación, actualización, desinstalación o un error en el nivel de herramienta). Para update con varias herramientas, al menos una falló.
• 3 — error de validación (alias desconocido, paquete no en la lista blanca, cadena de versión no válida).

Consulta Códigos de salida para ver la tabla completa.

Ver también

• Herramientas (complementos) : el modelo de complemento, la fijación de la versión, la ubicación de la instalación y el soporte de terceros.
• Instalar UiPath CLI : instala el host y luego incorpora las herramientas.
• Control de la instalación automática de la herramienta : por qué no hay opción de exclusión y cómo mantener los tiempos de compilación de CI deterministas.
• Control de versiones y estabilidad : contrato de servidor en host y herramientas.