Reference overview

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:

1. Cross-cutting — behavior that applies to every uip invocation regardless of tool.
2. Core commands — commands the host owns (login, logout, tools, skills, mcp, completion).
3. 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

ページ	What it covers
Global options	--output, --output-filter, --log-level, --log-file — the four flags available on every command.
終了コード	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.

コマンド	目的
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, Gemini CLI, Codex, OpenCode).
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.

ツール

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.

エイリアス	ツール	参照
or	Orchestrator	uip or
solution	解決策	uip solution
agent	オペレーター	uip agent
flow	Flow (explicit install only — not on auto-install whitelist)	uip flow
maestro	Maestro	uip maestro
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
resource	Resource (assets, queues, buckets, triggers, webhooks)	uip resource
is	Integration Service	uip is
codedagent	コード化されたエージェント	uip codedagent
codedapp	Coded App	uip codedapp
api-workflow	API ワークフロー	uip api-workflow
vss	Vertical Solutions	uip vss
df	Data Fabric	uip df
insights	Insights	uip insights
traces	トレース	uip traces
docsai	DocsAI	uip docsai

How to read a command page

Every command's reference page follows the same structure:

1. Synopsis — the one-line command shape, showing positional arguments and the common flag set.
2. Description — a paragraph or two on what the command does and where it fits in a workflow.
3. Arguments — table of positional arguments: name, required / optional, purpose.
4. 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.
5. Examples — three or more worked examples: minimal, common case, scripting-friendly (with --output-filter or explicit JSON handling).
6. Exit codes — a pointer to Exit codes plus any command-specific overrides.
7. Related commands — commands frequently used with this one.
8. 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.

命名規則

• Command prefix. uip is 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, -t for --tenant), both are listed together in the options table; examples use the long form for readability.
• JSON samples. --output json is 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.