uipath-cli
latest
false
- Release notes
- Overview
- Public preview
UiPath CLI release notes
Last updated May 7, 2026
Release date: May 7, 2026
Public preview of UiPath CLI as @uipath/cli on npm, replacing the legacy uipcli.exe .NET tool.
Added
- Host:
uipexecutable with core commandslogin,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— aliasor. Jobs, folders, processes, packages, machines, users, roles, licenses, feeds, attachments, sessions, calendars, credential-stores, audit-logs, settings.@uipath/solution-tool— aliassolution. Scaffold, pack, publish, upload, project management, deploy lifecycle, packages.@uipath/resource-tool— aliasresource. Assets, queues, storage buckets, libraries, triggers, webhooks.@uipath/agent-tool— aliasagent. Full Agent authoring + deploy + run + eval.@uipath/codedagent-tool— aliascodedagent. Bridge to the PythonuipathCLI for Coded Agents.@uipath/codedapp-tool— aliascodedapp. Coded web apps.@uipath/maestro-tool— aliasmaestro. Maestro BPMN processes, instances, incidents.@uipath/test-manager-tool— aliastm. Project, test case, test set, execution, result, report, attachment, wait.@uipath/integrationservice-tool— aliasis. Connectors, connections, activities, resources, triggers.@uipath/vertical-solutions-tool— aliasvss.@uipath/api-workflow-tool— aliasapi-workflow.@uipath/data-fabric-tool— aliasdf.@uipath/insights-tool— aliasinsights.@uipath/traces-tool— aliastraces.@uipath/docsai-tool— aliasdocsai.
@uipath/rpa-tool— aliasrpa. 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@uipathscope to resolve from GitHub before runninguip tools install @uipath/rpa-tool— see Installing UiPath CLI — Installing from the GitHub npm registry. Runtime prerequisite: a .NET runtime on the machine that runsuip rpacommands. See Breaking changes — Runtime change.@uipath/flow-tool— aliasflow. Published but not on the auto-install whitelist in the current release; install explicitly withuip tools install @uipath/flow-toolbefore usinguip flowcommands. Planned for whitelist inclusion in a later release.@uipath/rpa-legacy-tool— aliasrpa-legacy. Windows-only wrapper arounduipcli.exefor the Studio commands not yet ported to the cross-platformrpatool:debug,validate,find-activities,find-package,type-definition,package. Not on the auto-install whitelist; install explicitly withuip 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, plus130for user cancellation. - Authentication flows: interactive OAuth2, External App client credentials (with
env.VARresolver), environment-variable auth (opaque JWT viaUIPATH_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
jqis on PATH), fish, and pwsh. - Skills: supported coding agents — Claude Code, Cursor, GitHub Copilot, Gemini CLI, Codex, OpenCode.
- MCP bridge:
uip mcp serveexposes 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_SECRETenv 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
loginpath. 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 commands —
uip rpa packproduces a.nupkgper Studio project (same as the legacyuipcli package pack);uip solution packproduces a.zipbundle 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.
Known issues
uip tm waittimeout exit code. Emits2on timeout, reusing theAuthenticationErrorslot. Scripts that branch on2for "re-authenticate" should special-casetm wait. Dedicated4(TimeoutError) is reserved in the exit-code contract and may be adopted in a future MINOR release.uip flow processes listfilters by Flow type;uip maestro processes listdoes not. The Maestro variant returns tenant-wide process summaries including other tool types. Under review.uip vss add connectionis registered but not implemented (tracked as AGVSOL-1569). Returns a clear error when invoked.- No opt-out for tool auto-install.
CI=trueis not respected. Pre-install tools explicitly in CI steps to keep build times deterministic. rpa-toolrequires GitHub-registry setup.@uipath/rpa-toolis hosted on the GitHub npm registry, not the public one. A defaultnpm installon a fresh machine cannot resolve it until the@uipathscope is configured — see Installing UiPath CLI. Once configured,uip tools install @uipath/rpa-tooland subsequent auto-install invocations work normally.
Telemetry
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.