uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
使用“uip 或”工具管理 Orchestrator 作业、文件夹、流程、包、计算机、用户、角色和许可证。
uip or是 Orchestrator 工具:它管理 UiPath Orchestrator 租户上的作业、文件夹、流程、包、计算机、用户、角色、许可证、订阅源和附件。使用uip tools install or安装,或调用uip or …并运行自动安装。有关管理工具安装的命令,请参阅工具(插件)和UIP 工具。
资源
每个资源都有其自己的参考页面。每个页面上设置的动词与uip or注册的命令匹配 — 运行uip or --help以确认安装的完整表面。
| 资源 | 用途 |
|---|---|
| 作业 | 启动、停止、重新启动、继续和检查流程执行情况;获取日志、追踪记录、修复数据和状态历史记录。 |
| 文件夹 | 创建、列出、移动、编辑和删除文件夹;检查运行时分配。 |
| 流程 | 将包作为可运行流程绑定到文件夹;更新、回滚和编辑。 |
| 包 | 上传、下载、列出并检查.nupkg自动化包及其入口点。 |
| 计算机 | 管理计算机模型和槽分配;将计算机分配到文件夹。 |
| 用户 | 创建、编辑、删除和分配 Orchestrator 用户;管理租户级别的角色分配。 |
| 角色 | 在租户和文件夹作用域内管理角色、权限和角色用户成员身份。 |
| 许可证 | 列出 runtime 和 Named-User 许可证分配情况;切换计算机许可证;查看租户许可证摘要。 |
| 订阅源 | 列出当前用户可用的包订阅源。 |
| 附件 | 列出和下载作业附件。 |
大纲
uip or <resource> <verb> [options]
uip or <resource> <verb> [options]
始终为uip or ,从不uip orchestrator 。or是工具的命令前缀(请参阅uip tools list中的commandPrefix列)。
如何阅读本节
每个资源页面的结构都相同:
- 大纲—
uip or <resource> <verb>命令形状。 - 动词— 包含资源公开的每个动词的单行表格。
- 每个动词一个 H2 — 描述、位置参数(如果有)、标志表格、三个示例(最简单的示例、常见的情况、支持使用
--output-filter编写的脚本)以及在--output json下返回的Data形状。 - 退出代码— 指向共享退出代码合同的指针,其中内联调用了任何特定于动词的覆盖。
- 相关命令和“另请参阅— 交叉链接”,指向同级资源和相关概念页面。
默认输出格式为--output json 。每个页面上的数据形状都反映 JSON 有效负载 — 表格、yaml 和纯渲染源自同一个Data对象。
常用标志
只有一小部分标志会在大多数资源中重复出现。无论它们出现在何处,它们的行为方式均相同:
| 标记 | 使用人 | 用途 |
|---|---|---|
-t, --tenant <tenant-name> | 每个动词 | 覆盖在身份验证时选择的租户。可选;以使用会话默认值。请参阅身份验证。 |
--folder-path <path> | 大多数限定文件夹范围的动词 | 完全限定路径(例如, Shared 、 Production/EU )对应的目标文件夹。 |
--folder-key <key> | 大多数限定文件夹范围的动词 | 按 GUID 划分的目标文件夹。可与--folder-path互用;解析同一文件夹。 |
-l, --limit <number> | 每个列表动词 | 页面大小。默认为 CLI 的DEFAULT_PAGE_SIZE (在撰写本文时为 50)。 |
--offset <number> | 每个列表动词 | 返回之前要跳过的项目数。默认为0 。 |
--order-by <field> | 大多数列表动词 | OData 排序表达式(例如, Name asc 、 Id desc )。每个动词都记录其默认值。 |
--all-fields | list / get多个动词 | 返回原始 API 响应,而不是策划摘要。当您需要默认形状省略的字段时非常有用。 |
每个资源页面上都记录了动词级标志(筛选器、输入/输出路径、策略、优先级)。
全局选项和退出代码
所有uip or动词都遵循四个全局选项( --output 、 --output-filter 、 --log-level和--log-file )。退出代码遵循共享合同;任何特定于动词的覆盖都会在相关资源页面上调用。
另请参阅
- 概念:UiPath CLI 的组织方式— 工具在“主机 + 工具”模型中的位置。
- 会话— 如何解析租户和文件夹上下文。
- 配置— 影响每个工具的环境变量和配置文件。
- 快速入门和您的第一个管道— 运用
uip or端到端演练。