UIP 或

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) for the install model and uip tools for the command that manages tool installation.

资源

每个资源都有其自己的参考页面。每个页面上设置的动词与uip or注册的命令匹配 — 运行uip or --help以确认安装的完整表面。

资源	用途
作业	启动、停止、重新启动、继续和检查流程执行情况；获取日志、追踪记录、修复数据和状态历史记录。
文件夹	创建、列出、移动、编辑和删除文件夹；检查运行时分配。
流程	将包作为可运行流程绑定到文件夹；更新、回滚和编辑。
包	上传、下载、列出并检查.nupkg自动化包及其入口点。
计算机	管理计算机模型和槽分配；将计算机分配到文件夹。
用户	创建、编辑、删除和分配 Orchestrator 用户；管理租户级别的角色分配。
角色	在租户和文件夹作用域内管理角色、权限和角色用户成员身份。
许可证	列出 runtime 和 Named-User 许可证分配情况；切换计算机许可证；查看租户许可证摘要。
订阅源	列出当前用户可用的包订阅源。
附件	列出和下载作业附件。
资产	自动化在运行时使用的命名配置值（Text、Bool、Integer、Credential、Secret）。文件夹范围。
存储桶	自动化使用的文件的存储容器。文件夹范围。
存储桶文件	存储桶中的单个文件。列出、上传、下载、删除和获取预签名 URL。
库	可重用.nupkg包（共享活动和逻辑）。租户范围。
队列	事务工作项目的容器。文件夹范围。
队列项目	队列内的单个事务，具有完整的状态机控件。文件夹范围。
触发器	用于启动作业的时间、队列和 API 触发器。时间/队列触发器是文件夹作用域； API 触发器在租户范围内。
Webhooks	在平台事件（作业完成、队列项目失败等）上触发的 HTTP 回调。租户范围。
凭据存储	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 (package @uipath/eval-tool, not a uip or sub-command, even though every verb operates against an Orchestrator process/folder).

大纲

uip or <resource> <verb> [options]

始终为uip or ，从不uip orchestrator 。or是工具的命令前缀（请参阅uip tools list中的commandPrefix列）。

如何阅读本节

每个资源页面的结构都相同：

1. 大纲— uip or <resource> <verb>命令形状。
2. 动词— 包含资源公开的每个动词的单行表格。
3. 每个动词一个 H2 — 描述、位置参数（如果有）、标志表格、三个示例（最简单的示例、常见的情况、支持使用--output-filter编写的脚本）以及在--output json下返回的Data形状。
4. 退出代码— 指向共享退出代码合同的指针，其中内联调用了任何特定于动词的覆盖。
5. 相关命令和“另请参阅— 交叉链接”，指向同级资源和相关概念页面。

默认输出格式为--output json 。每个页面上的数据形状都反映 JSON 有效负载 — 表格、yaml 和纯渲染源自同一个Data对象。

常用标志

只有一小部分标志会在大多数资源中重复出现。无论它们出现在何处，它们的行为方式均相同：

标记	使用人	用途
--folder-path <path>	大多数限定文件夹范围的动词	完全限定路径（例如， Shared 、 Production/EU ）对应的目标文件夹。
--folder-key <key>	大多数限定文件夹范围的动词	按 GUID 划分的目标文件夹。可与--folder-path互用；解析同一文件夹。
--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>	每个列表动词	页面大小。默认为 CLI 的DEFAULT_PAGE_SIZE （在撰写本文时为 50）。
--offset <number>	每个列表动词	返回之前要跳过的项目数。默认为0 。
--sort-by <field>	大多数列表动词	OData 排序表达式（例如， Name asc 、 Id desc ）。每个动词都记录其默认值。
--all-fields	list / get多个动词	返回原始 API 响应，而不是策划摘要。当您需要默认形状省略的字段时非常有用。
-y, --yes	every destructive (delete) verb	Confirm the operation. Required — the CLI never prompts interactively for a destructive action.

每个资源页面上都记录了动词级标志（筛选器、输入/输出路径、策略、优先级）。

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-*.
• 键。大多数资源由list输出中返回的 GUID 标识（在key 、 identifier下返回，或者在uniqueKey和key下重试链）。数字id字段是内部字段，不应传递给命令。
• 筛选。在支持的情况下， -n, --name <name>是资源名称的包含匹配项；部分资源添加--enabled 、 --disabled和--status等。

全局选项和退出代码

所有uip or动词都遵循四个全局选项（ --output 、 --output-filter 、 --log-level和--log-file ）。退出代码遵循共享合同；任何特定于动词的覆盖都会在相关资源页面上调用。

另请参阅

• 概念：UiPath CLI 的组织方式— 工具在“主机 + 工具”模型中的位置。
• 会话— 如何解析租户和文件夹上下文。
• 配置— 影响每个工具的环境变量和配置文件。
• 快速入门和您的第一个管道— 运用uip or端到端演练。