# uip or

> Manage Orchestrator jobs, folders, processes, packages, machines, users, roles, licenses, and runtime resources using the `uip or` tool.

`uip or` is the Orchestrator tool: it manages jobs, folders, processes, packages, machines, users, roles, licenses, feeds, attachments, and the runtime resources automations depend on (assets, buckets, queues, triggers, libraries, webhooks) on a UiPath Orchestrator tenant. Install it with `uip tools install or`, or invoke `uip or …` and let auto-install run. See [Tools (plugins)](./concepts-tools.md) for the install model and [uip tools](./uip-tools.md) 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](./uip-or-jobs.md) | Start, stop, restart, resume, and inspect process executions; fetch logs, traces, healing data, and state history. |
| [folders](./uip-or-folders.md) | Create, list, move, edit, and delete folders; inspect runtime allocation. |
| [processes](./uip-or-processes.md) | Bind packages to folders as runnable processes; update, rollback, and edit. |
| [packages](./uip-or-packages.md) | Upload, download, list, and inspect `.nupkg` automation packages and their entry points. |
| [machines](./uip-or-machines.md) | Manage machine templates and slot allocations; assign machines to folders. |
| [users](./uip-or-users.md) | Create, edit, delete, and assign Orchestrator users; manage tenant-level role assignments. |
| [roles](./uip-or-roles.md) | Manage roles, permissions, and role-user membership at tenant and folder scope. |
| [licenses](./uip-or-licenses.md) | List runtime and named-user license assignments; toggle machine licensing; view tenant license summary. |
| [feeds](./uip-or-feeds.md) | List package feeds available to the current user. |
| [attachments](./uip-or-attachments.md) | List and download job attachments. |
| [assets](./uip-or-assets.md) | Named configuration values (Text, Bool, Integer, Credential, Secret) used by automations at runtime. Folder-scoped. |
| [buckets](./uip-or-buckets.md) | Storage containers for files used by automations. Folder-scoped. |
| [bucket-files](./uip-or-bucket-files.md) | Individual files inside a bucket. List, upload, download, delete, fetch pre-signed URLs. |
| [libraries](./uip-or-libraries.md) | Reusable `.nupkg` packages (shared activities and logic). Tenant-scoped. |
| [queues](./uip-or-queues.md) | Containers for transactional work items. Folder-scoped. |
| [queue-items](./uip-or-queue-items.md) | Individual transactions inside queues, with full state-machine controls. Folder-scoped. |
| [triggers](./uip-or-triggers.md) | Time, queue, and API triggers that start jobs. Time/queue triggers are folder-scoped; API triggers are tenant-scoped. |
| [webhooks](./uip-or-webhooks.md) | HTTP callbacks fired on platform events (job completion, queue-item failure, …). Tenant-scoped. |
| [credential-stores](./uip-or-credential-stores.md) | List and inspect external credential store configurations used by Credential/Secret assets and Azure/Amazon buckets. |

Runtime evaluation of deployed packages — submitting runs, scoring outputs, and managing evaluators/eval sets/schedules against an Orchestrator process — is a separate, standalone tool: [`uip eval`](./uip-eval.md) (package `@uipath/eval-tool`, **not** a `uip or` sub-command, even though every verb operates against an Orchestrator process/folder).

## Synopsis

```
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:

1. **Synopsis** — the `uip or <resource> <verb>` command shape.
2. **Verbs** — a one-line table of every verb the resource exposes.
3. **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`.
4. **Exit codes** — a pointer to the shared [Exit codes](./exit-codes.md) contract, with any verb-specific overrides called out inline.
5. **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 |
|---|---|---|
| `--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. |
| `--all-folders` | `list` on some folder-scoped resources (for example, `assets`, `buckets`) | List across every folder accessible to the caller instead of scoping to one. Where supported, one of `--folder-path`, `--folder-key`, or `--all-folders` is required. |
| `-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`. |
| `--sort-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. |
| `-y, --yes` | every destructive (`delete`) verb | Confirm the operation. Required — the CLI never prompts interactively for a destructive action. |

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

### Runtime-resource conventions

The runtime-resource pages (assets, buckets, bucket-files, libraries, queues, queue-items, triggers, webhooks) share a few additional conventions on top of the ones above:

- **Folder scoping.** Assets, buckets, queues, queue items, and triggers (time / queue) are folder-scoped. Provide **either** `--folder-path <path>` (e.g. `"Shared"`) **or** `--folder-key <guid>` on `list`, `create`, and related calls — or `--all-folders` where that flag is supported. `get`, `update`, and `delete` resolve cross-folder by key when feasible; each verb's description on the resource page calls it out explicitly. **Libraries, API triggers, and webhooks are tenant-scoped** and do not accept `--folder-*`.
- **Keys.** Most resources are identified by a GUID returned in `list` output (under `key`, `identifier`, or — for queue items — `uniqueKey` for a single attempt and `key` for the retry chain). Numeric `id` fields are internal and should not be passed to commands.
- **Filtering.** Where supported, `-n, --name <name>` is a contains-match on the resource name; some resources add `--enabled`, `--disabled`, `--status`, etc.

## Global options and exit codes

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

## See also

- [Concepts: how UiPath CLI is organized](./concepts-cli-architecture.md) — where tools fit in the host + tool model.
- [Sessions](./concepts-sessions.md) — how tenant and folder context are resolved.
- [Configuration](./configuration.md) — environment variables and config files that affect every tool.
- [Quickstart](./quickstart.md) and [Your first pipeline](./first-pipeline.md) — end-to-end walkthroughs that exercise `uip or`.