Herramientas de UIP

Sintaxis y opciones para `herramientas de uip`, que instala, actualiza y elimina las herramientas basadas en npm que amplían UiPath CLI.

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>]
uip tools uninstall [<package>] [--all]

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

Forma de datos (--output json)

{
  "Code": "ToolList",
  "Data": [
    {
      "Name": "orchestrator-tool",
      "Version": "1.2.3",
      "Description": "UiPath Orchestrator Tool",
      "CommandPrefix": "or",
      "Status": "ok"
    },
    {
      "Name": "agent-tool",
      "Version": "1.1.7",
      "Description": "UiPath Agent Tool",
      "CommandPrefix": "agent",
      "Status": "needs update"
    }
  ]
}

Campo	Descripción
Name	Nombre de la herramienta.
Version	Installed version.
Description	Descripción de la herramienta.
CommandPrefix	The top-level alias you type — for example, or for Orchestrator. Use it to confirm what uip <prefix> … runs.
Status	ok when the installed version is on the running CLI's MAJOR.MINOR line. needs update when it is off that line; the CLI replaces the tool with a version on its line the next time you run one of the tool's commands. In an interactive table, needs update rows are highlighted.

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/ de la lista de permitidas (incluida rpa-legacy, que requiere 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 de permitidas.

Opciones

Nada.

Ejemplo

uip tools search orchestrator

Forma de datos (--output json)

{
  "Code": "SearchResult",
  "Data": [
    {
      "Name": "@uipath/orchestrator-tool",
      "LatestVersion": "1.2.3",
      "Description": "Manage UiPath Orchestrator resources from the CLI",
      "AvailableVersions": ["1.2.3", "1.2.2", "1.2.1"]
    }
  ]
}

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 en función de la lista de permisos, por lo que se omite cualquier paquete @uipath/ que no esté en la lista de permisos.

Instalación de herramientas de UIP

Install an allowlisted tool from the npm registry. The CLI resolves the version from whichever registry npm's own configuration sets for the @uipath scope (a scoped @uipath:registry entry in .npmrc, otherwise npm's default registry).

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. El valor después de @ debe ser una cadena de servidor válida (por ejemplo 1.0.2 o 1.0.0-preview.1): un nombre de canal simple como @beta se rechaza con un ValidationError.

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

# exact preview build
uip tools install orchestrator-tool@1.0.0-preview.1

# preview channel — switch the channel, then install normally
uip config set updateChannel preview
uip tools install orchestrator-tool

Resolución de la versión

• Con una versión explícita del servidor (p. ej. @1.0.2 o @1.0.0-preview.1), esa versión se utiliza tal cual. No existe una abreviatura npm-dist-tag como @beta: el valor después de @ debe analizarse como semver, o el comando falla con un ValidationError.
• Sin una versión, el host se resuelve contra el canal de actualización de CLI (stable de forma predeterminada, o preview/dev a través de uip config set updateChannel <channel>) y su línea MAYOR.MINOR actual, por lo que se instala stable CLI 1.0.x la última herramienta estable coincidente 1.0.*. Esto mantiene el host y la herramienta compatibles con el protocolo. Consulta Control de versiones y estabilidad y uip config.

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 de permitidos: <package-spec> debe resolverse en uno de los paquetes @uipath/ de la lista de permitidos (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.

Forma de datos (--output json)

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

Failures

When no version can be resolved for the CLI's line, the failure envelope carries an ErrorCode that names the cause. When npm's configuration can be read, the message also names the registry that was queried.

ErrorCode	Causa	Qué hacer
authentication_required	The registry rejected the credentials.	Fix that registry's credentials in .npmrc, then re-run.
network_error	The registry could not be reached.	Check network access and any proxy or registry configuration in .npmrc, then re-run.
not_found	The registry has no version of the tool on the CLI's MAJOR.MINOR line.	Install a build for this line with uip tools install <tool>@<version>, run uip update to move the CLI onto a line that publishes the tool, or point the @uipath scope at the registry that publishes it.
server_error	The registry returned metadata the CLI could not read.	Re-run. If it persists, check whether a proxy or mirror is rewriting the response.

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.

Importante:

No hay ningún marcador --version en uip tools update: solo --name está registrado. Cada herramienta se actualiza a la última versión permitida por la política de versión activa (normalmente anclada a la línea MAYOR.MINOR de CLI); para anclar una versión específica en su lugar, utiliza uip config set version <line> o reinstala con una versión explícita a través de uip tools install <package>@<version>.

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

Forma de datos (--output json)

{
  "Code": "UpdateResult",
  "Data": [
    {
      "Name": "orchestrator-tool",
      "Status": "updated",
      "From": "1.2.2",
      "To": "1.2.3"
    },
    {
      "Name": "agent-tool",
      "Status": "up-to-date",
      "From": "1.2.3",
      "To": "1.2.3"
    }
  ]
}

Status is updated or up-to-date. If any tool fails to update, the command emits a Failure envelope naming the number of tools that failed, and exits with code 1. Run with --log-level debug to see the per-tool error.

Si core.version está anclado a una versión exacta (no a una línea MAJOR.MINOR), la actualización se omite por completo: el comando sigue saliendo de 0 con una matriz Data vacía y una nota Instructions que explica el anclaje, ya que una instalación anclada intencionadamente nunca se mueve.

Desinstalación de herramientas UIP

Elimina una herramienta instalada o todas las herramientas instaladas a la vez.

Argumentos

• [package-name] opcional) : alias, nombre corto o nombre completo de npm. Mutuamente exclusivo con --all. Proporciona exactamente uno de los argumentos o --all: omitir ambos, o pasar ambos, es un ValidationError.

Opciones

• --all: desinstala todas las herramientas instaladas. Mutuamente exclusivo con [package-name].

Ejemplos

# uninstall a single tool
uip tools uninstall orchestrator
uip tools uninstall @uipath/solution-tool

# uninstall every installed tool
uip tools uninstall --all

Forma de datos (--output json)

Desinstalar una sola herramienta emite Code: "Message":

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

--all emite Code: "UninstallResult" con una fila por herramienta:

{
  "Code": "UninstallResult",
  "Data": [
    { "Name": "orchestrator-tool", "Status": "uninstalled" },
    { "Name": "agent-tool", "Status": "uninstalled" }
  ]
}

Status is uninstalled, skipped for a tool that ships with the CLI itself, or failed. Skipped and failed rows carry an Error field. If any tool fails to uninstall in the --all path, the command exits with code 1 — the full per-tool breakdown is still emitted.

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 incluido en la lista de permitidos, cadena de versión no válida) en install y update.

Los propios errores de validación de argumentos de uninstall (falta el nombre del paquete o --all combinado con un nombre de paquete) dan salida a 1 en lugar de 3, aunque el cuerpo de la respuesta sigue informando Result: "ValidationError" — rama en Result/ErrorCode en el cuerpo JSON en lugar del código de salida si necesitas distinguir este caso de otros fallos.

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.