UiPath Documentation
uipath-cli
latest
false
  • Notas de versão
    • Visão geral
    • Visualização pública

Notas de versão do UiPath CLI

Última atualização 7 de mai de 2026

Visualização pública

Release date: May 7, 2026

Public preview of UiPath CLI as @uipath/cli on npm, replacing the legacy uipcli.exe .NET tool.

Adicionado

  • Host: uip executable with core commands login, logout, login status, login tenant list, login tenant set, tools (list / search / install / update / uninstall), skills (install / update / uninstall), mcp, completion.
  • Tools (auto-install whitelist; installed on first use or via uip tools install):
    • @uipath/orchestrator-tool — alias or. Jobs, folders, processes, packages, machines, users, roles, licenses, feeds, attachments, sessions, calendars, credential-stores, audit-logs, settings.
    • @uipath/solution-tool — alias solution. Scaffold, pack, publish, upload, project management, deploy lifecycle, packages.
    • @uipath/resource-tool — alias resource. Assets, queues, storage buckets, libraries, triggers, webhooks.
    • @uipath/agent-tool — alias agent. Full Agent authoring + deploy + run + eval.
    • @uipath/codedagent-tool — alias codedagent. Bridge to the Python uipath CLI for Coded Agents.
    • @uipath/codedapp-tool — alias codedapp. Coded web apps.
    • @uipath/maestro-tool — alias maestro. Maestro BPMN processes, instances, incidents.
    • @uipath/test-manager-tool — alias tm. Project, test case, test set, execution, result, report, attachment, wait.
    • @uipath/integrationservice-tool — alias is. Connectors, connections, activities, resources, triggers.
    • @uipath/vertical-solutions-tool — alias vss.
    • @uipath/api-workflow-tool — alias api-workflow.
    • @uipath/data-fabric-tool — alias df.
    • @uipath/insights-tool — alias insights.
    • @uipath/traces-tool — alias traces.
    • @uipath/docsai-tool — alias docsai.
  • @uipath/rpa-tool — alias rpa. Studio project packaging, analyzer, and restore. Published on the GitHub npm registry (https://npm.pkg.github.com) rather than the public npm registry because it bundles .NET-backed Studio components; configure the @uipath scope to resolve from GitHub before running uip tools install @uipath/rpa-tool — see Installing UiPath CLI — Installing from the GitHub npm registry. Runtime prerequisite: a .NET runtime on the machine that runs uip rpa commands. See Breaking changes — Runtime change.
  • @uipath/flow-tool — alias flow. Published but not on the auto-install whitelist in the current release; install explicitly with uip tools install @uipath/flow-tool before using uip flow commands. Planned for whitelist inclusion in a later release.
  • @uipath/rpa-legacy-tool — alias rpa-legacy. Windows-only wrapper around uipcli.exe for the Studio commands not yet ported to the cross-platform rpa tool: debug, validate, find-activities, find-package, type-definition, package. Not on the auto-install whitelist; install explicitly with uip tools install @uipath/rpa-legacy-tool. See uip rpa-legacy.
  • Global options: --output, --output-filter (JMESPath), --log-level, --log-file.
  • Output formats: table, json (default), yaml, plain.
  • Exit codes: five-tier contract — 0 / 1 / 2 / 3 / 4, plus 130 for user cancellation.
  • Authentication flows: interactive OAuth2, External App client credentials (with env.VAR resolver), environment-variable auth (opaque JWT via UIPATH_CLI_ENABLE_ENV_AUTH=true).
  • Configuration: environment variables (UIPATH_URL, UIPATH_CLI_*, UIPATH_TELEMETRY_DISABLED, etc.) plus per-command flags, with a documented precedence chain (flag > env var > default).
  • Shell completion: bash, zsh (with dynamic flag-value completion when jq is on PATH), fish, and pwsh.
  • Skills: supported coding agents — Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex, OpenCode.
  • MCP bridge: uip mcp serve exposes a single MCP tool (run_command) over stdio.

Breaking changes vs legacy uipcli.exe

See the migration guide for the full list. Highlights:

  • No implicit UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET env reading. Pass them explicitly: uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET.
  • Basic auth and token auth removed on the login path. Use interactive OAuth2 or External App.
  • Calendar-versioned folders gone. Documentation lives at uipath-cli/standalone/latest/ with a living reference; per-version deltas are here.
  • Package pack commandsuip rpa pack produces a .nupkg per Studio project (same as the legacy uipcli package pack); uip solution pack produces a .zip bundle of the entire Solution (same format the Solution tooling has always used). Which one you want depends on whether you are packaging a single Studio project or a full Solution.

Problemas conhecidos

  • uip tm wait timeout exit code. Emits 2 on timeout, reusing the AuthenticationError slot. Scripts that branch on 2 for "re-authenticate" should special-case tm wait. Dedicated 4 (TimeoutError) is reserved in the exit-code contract and may be adopted in a future MINOR release.
  • uip flow processes list filters by Flow type; uip maestro processes list does not. The Maestro variant returns tenant-wide process summaries including other tool types. Under review.
  • uip vss add connection is registered but not implemented (tracked as AGVSOL-1569). Returns a clear error when invoked.
  • No opt-out for tool auto-install. CI=true is not respected. Pre-install tools explicitly in CI steps to keep build times deterministic.
  • rpa-tool requires GitHub-registry setup. @uipath/rpa-tool is hosted on the GitHub npm registry, not the public one. A default npm install on a fresh machine cannot resolve it until the @uipath scope is configured — see Installing UiPath CLI. Once configured, uip tools install @uipath/rpa-tool and subsequent auto-install invocations work normally.

Telemetria

Anonymous usage telemetry is enabled by default and sent to UiPath's Application Insights. Opt out with UIPATH_TELEMETRY_DISABLED=1, or redirect with UIPATH_AI_CONNECTION_STRING. No command arguments, file contents, or credentials are transmitted.

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades