uipath-cli
latest
false
UiPath CLI user guide
- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
Reference index for every `uip` command, flag, and exit code, organized by tool and split into linked pages.
The reference documents every uip command, flag, and exit code. Use it as a lookup when you know what you want to do and need the exact syntax. For learning, start at the Quickstart or How UiPath CLI is organized.
How the reference is organized
The reference is split into three kinds of page:
- Cross-cutting — behavior that applies to every
uipinvocation regardless of tool. - Core commands — commands the host owns (
login,logout,tools,skills,mcp,completion). - Per-tool — one section per installable tool; each section has an overview plus one page per resource (for resource-first tools) or per verb (for single-workflow tools).
Cross-cutting
| Page | What it covers |
|---|---|
| Global options | --output, --output-filter, --log-level, --log-file — the four flags available on every command. |
| Exit codes | The five-tier exit-code contract (0 / 1 / 2 / 3 / 4) plus 130 for user cancellation. |
Core commands
Commands the host registers directly. No tool installation required.
| Command | Purpose |
|---|---|
| uip login | Start an interactive OAuth2 session, authenticate as an External App, or switch tenants. |
| uip logout | Remove the stored credentials. |
| uip login status | Show the current session's org, tenant, and expiration. |
| uip tools | List, search, install, update, or uninstall installable tools. |
| uip skills | Install UiPath skills into coding agents (Claude Code, Cursor, GitHub Copilot, Codex, OpenCode, Autopilot, Kiro, Windsurf, Antigravity, Devin). |
| uip mcp | Expose uip commands over the Model Context Protocol for MCP-aware clients. |
| uip completion | Install, print, or remove shell tab completion for bash, zsh, fish, and pwsh. |
| uip config | Get, set, or clear local CLI configuration preferences (output format, log level, version/update-channel policy). |
| uip user | Show identity information about the currently logged-in session. |
| uip update | Update installed tools and skills, and check for or apply a newer CLI version. |
| uip feedback | Send a bug report or improvement suggestion to the UiPath team. |
Tools
Each tool is an installable npm package. Run uip tools install <alias> to add it, or invoke it once and let auto-install do the work. See Tools (plugins) for the model and uip tools for the command that manages them.
| Alias | Tool | Reference |
|---|---|---|
or | Orchestrator (jobs, processes, folders, machines, users, licenses, and runtime resources — assets, buckets, queues, triggers, libraries, webhooks) | uip or |
platform | Platform (tenant licensing, user bundles, group rules, consumables) | uip platform |
solution | Solution | uip solution |
agent | Agent | uip agent |
maestro | Maestro — one installable package, three independent sibling surfaces; there is no bare uip maestro command | uip maestro bpmn, uip maestro flow, uip maestro case |
tm | Test Manager | uip tm |
rpa | RPA (Studio packaging, analyzer, restore) | uip rpa |
rpa-legacy | RPA Legacy — Windows-only wrapper around uipcli.exe (debug, validate, find-activities, find-package, type-definition, package) | uip rpa-legacy |
is | Integration Service | uip is |
codedagent | Coded Agent | uip codedagent |
codedapp | Coded App | uip codedapp |
api-workflow | API Workflow | uip api-workflow |
vss | Vertical Solutions | uip vss |
df | Data Fabric | uip df |
insights | Insights | uip insights |
traces | Traces | uip traces |
docsai | DocsAI | uip docsai |
eval | Runtime evaluation of Orchestrator packages — evaluators, eval sets, evaluations, schedules | uip eval |
admin | Admin (users, groups, robot accounts, external apps, SMTP, authorization, IP restriction, organizations, tenants, VPN gateways, resource catalog, audit) | uip admin |
agenthub | AgentHub (MCP server registrations, tools, remote A2A agents) | uip agenthub |
ah | Automation Hub (ideas, pipeline, taxonomy, users) | uip ah |
aops | StudioAdmin AOps (connections, repos, projects, solutions, pipelines, executions) | uip aops |
coder | Coder — AI coding agent (Preview build only) | uip coder |
context-grounding | Context Grounding (Python bridge) | uip context-grounding |
conversational | Conversational (chat, agents, conversation history, trunks) | uip conversational |
function | Functions — build, serve, publish JS/TS and Python Functions | uip function |
gov | Governance (AOps policies, access policies, compliance packs) | uip gov |
guardrails | Guardrails (BYO guardrail configurations, AI Trust Layer) | uip guardrails |
ixp | IXP — Intelligent Document Processing (projects, taxonomy, documents, deployments) | uip ixp |
llm-configuration | LLM Configuration — BYO LLM connections (AI Trust Layer) | uip llm-configuration |
llm-gateway | LLM Gateway — list available models | uip llm-gateway |
model-hub | Model Hub — LLM Gateway routing configuration | uip model-hub |
pm | Process Mining (apps, transformations, data ingestion) | uip pm |
tasks | Action Center tasks (catalogs, comments, labels, metadata, data) | uip tasks |
How to read a command page
Every command's reference page follows the same structure:
- Synopsis — the one-line command shape, showing positional arguments and the common flag set.
- Description — a paragraph or two on what the command does and where it fits in a workflow.
- Arguments — table of positional arguments: name, required / optional, purpose.
- Options — table of flags grouped by concern (identity, filtering, output, behavior). Each row shows short name, long name, value type, default, and a one-line description.
- Examples — three or more worked examples: minimal, common case, scripting-friendly (with
--output-filteror explicit JSON handling). - Exit codes — a pointer to Exit codes plus any command-specific overrides.
- Related commands — commands frequently used with this one.
- See also — concept and how-to pages that cover the command's context.
All pages inherit the global options; they are not repeated on every command.
Conventions
- Command prefix.
uipis the executable; every example starts with it. - Placeholders.
<angle-brackets>for required values,[square-brackets]for optional values. Replace with your real values. - Short flags. Where a flag has a short form (for example,
-tfor--tenant), both are listed together in the options table; examples use the long form for readability. - JSON samples.
--output jsonis the default. Examples that show output elide irrelevant fields with…to keep focus. - Version notes. Commands or flags labeled Preview may change without a MAJOR version bump. Commands labeled Deprecated keep working for at least one MAJOR cycle. See Versioning and stability.