UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

UIP 或

使用“uip 或”工具管理 Orchestrator 作业、文件夹、流程、包、计算机、用户、角色、许可证和 Runtime 资源。

uip or 是 Orchestrator 工具:它管理作业、文件夹、流程、包、计算机、用户、角色、许可证、订阅源、附件以及自动化所依赖的运行时资源(资产、存储桶、队列、触发器、库、Webhook) UiPath Orchestrator 租户。使用 uip tools install or 安装,或调用 uip or … 并运行自动安装。有关管理工具安装的命令,请参阅工具(插件)和UIP 工具。

资源​

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

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

已部署包的运行时评估(提交运行、输出评分以及根据 Orchestrator 流程管理评估程序/评估集/计划)是一个单独的独立工具: uip eval (包@uipath/eval-tool ,不是uip or子命令,即使每个动词都针对 Orchestrator 流程/文件夹进行操作)。

大纲​

uip or <resource> <verb> [options]
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-folderslist 某些文件夹作用域的资源(例如 assets、buckets)列出调用者可以访问的每个文件夹,而不是限定一个范围。如果支持,则需要 --folder-path、--folder-key 或 --all-folders 之一。
-l, --limit <number>每个列表动词页面大小。默认为 CLI 的DEFAULT_PAGE_SIZE (在撰写本文时为 50)。
--offset <number>每个列表动词返回之前要跳过的项目数。默认为0 。
--sort-by <field>大多数列表动词OData 排序表达式(例如, Name asc 、 Id desc )。每个动词都记录其默认值。
--all-fieldslist / get多个动词返回原始 API 响应,而不是策划摘要。当您需要默认形状省略的字段时非常有用。
-y, --yes每个破坏性 (delete) 动词确认操作。必需 — CLI 从不以交互方式提示执行破坏性操作。

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

运行时资源约定​

除上述约定外,runtime 资源页面(资产、存储桶、存储桶文件、库、队列、队列项目、触发器、Webhook)还有一些其他约定:

  • 文件夹作用域。资产、存储桶、队列、队列项目和触发器(时间/队列)位于文件夹范围内。提供--folder-path <path> 例如"Shared" )或--folder-key <guid> , list及相关调用 — 或--all-folders在支持该标志create情况下。get、update 和 delete 在可行时通过键解析跨文件夹;资源页面上每个动词的描述会明确指出。库、API 触发器和 Webhook 是租户范围内的,并且不接受--folder-* 。
  • 键。大多数资源由list输出中返回的 GUID 标识(在key 、 identifier下返回,或者在uniqueKey和key下重试链)。数字id字段是内部字段,不应传递给命令。
  • 筛选。在支持的情况下, -n, --name <name>是资源名称的包含匹配项;部分资源添加--enabled 、 --disabled和--status等。

全局选项和退出代码​

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

另请参阅​

  • 资源​
  • 大纲​
  • 如何阅读本节​
  • 常用标志​
  • 运行时资源约定​
  • 全局选项和退出代码​
  • 另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新