UiPath CLI user guide

Last updated May 7, 2026

uip or

uip or is the Orchestrator tool: it manages jobs, folders, processes, packages, machines, users, roles, licenses, feeds, and attachments on a UiPath Orchestrator tenant. Install it with uip tools install or, or invoke uip or … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation.

Resources

Each resource has its own reference page. The verb set on each page matches the commands registered by uip or — run uip or --help to confirm the full surface on your installation.

Resource	Purpose
jobs	Start, stop, restart, resume, and inspect process executions; fetch logs, traces, healing data, and state history.
folders	Create, list, move, edit, and delete folders; inspect runtime allocation.
processes	Bind packages to folders as runnable processes; update, rollback, and edit.
packages	Upload, download, list, and inspect `.nupkg` automation packages and their entry points.
machines	Manage machine templates and slot allocations; assign machines to folders.
users	Create, edit, delete, and assign Orchestrator users; manage tenant-level role assignments.
roles	Manage roles, permissions, and role-user membership at tenant and folder scope.
licenses	List runtime and named-user license assignments; toggle machine licensing; view tenant license summary.
feeds	List package feeds available to the current user.
attachments	List and download job attachments.

Synopsis

uip or <resource> <verb> [options]
uip or <resource> <verb> [options]

Always uip or, never uip orchestrator. or is the tool's command prefix (see the commandPrefix column in uip tools list).

How to read this section

Every resource page is structured the same way:

Synopsis — the uip or <resource> <verb> command shape.
Verbs — a one-line table of every verb the resource exposes.
One H2 per verb — description, positional arguments (if any), flag table, three examples (simplest, common case, scripting-friendly with --output-filter), and the Data shape returned under --output json.
Exit codes — a pointer to the shared Exit codes contract, with any verb-specific overrides called out inline.
Related commands and See also — cross-links to sibling resources and relevant concept pages.

Default output format is --output json. Data shapes on every page reflect the JSON payload — table, yaml, and plain renderings are derived from the same Data object.

Common flags

A small set of flags recurs across most resources. They behave the same way wherever they appear:

Flag	Used by	Purpose
`-t, --tenant <tenant-name>`	every verb	Override the tenant selected at authentication time. Optional; omit to use the session default. See Authentication.
`--folder-path <path>`	most verbs that scope to a folder	Target folder by fully-qualified path (for example, `Shared`, `Production/EU`).
`--folder-key <key>`	most verbs that scope to a folder	Target folder by GUID. Mutually usable with `--folder-path`; either resolves the same folder.
`-l, --limit <number>`	every list verb	Page size. Defaults to the CLI's `DEFAULT_PAGE_SIZE` (50 at time of writing).
`--offset <number>`	every list verb	Number of items to skip before returning. Defaults to `0`.
`--order-by <field>`	most list verbs	OData sort expression (for example, `Name asc`, `Id desc`). Each verb documents its default.
`--all-fields`	many `list` / `get` verbs	Return the raw API response instead of the curated summary. Useful when you need fields the default shape omits.

Verb-level flags (filters, input/output paths, strategies, priorities) are documented on each resource page.

Global options and exit codes

All uip or verbs honor the four global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the shared contract; any verb-specific override is called out on the relevant resource page.

Was this page helpful?

PREVIOUSregistry

NEXTjobs

UiPath CLI user guide

Resources​

Synopsis​

How to read this section​

Common flags​

Global options and exit codes​

See also​