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

UiPath CLI 用户指南

UIP 解决方案

uip solution用于构建、发布和部署解决方案— UiPath 项目(RPA 工作流、测试用例、库、智能体、Maestro 流程和应用程序)捆绑包作为单个工件进行交付和版本控制。解决方案由解决方案目录根目录下的.uipx清单文件定义;该清单中列出的每个项目都将一起打包、发布和部署。

您使用此工具的大部分时间都花费在三个步骤上:搭建或本地编辑解决方案( newproject ),将其打包到.zippack )中,然后将打包版本部署到 Orchestrator( publish + deploy run )。请参阅您的第一个管道,了解端到端演练。

动词分类

动词系列运算对象用途
new本地文件系统新建一个空的.uipx解决方案目录。
project本地 .uipx在解决方案清单文件中添加、导入或删除项目。
resource (通过uip solution resource …本地解决方案列出和刷新解决方案中的共享资源声明(队列、资产、存储桶、流程、连接)。请勿与 Orchestrator 资源工具uip resource混淆。
pack本地解决方案从解决方案目录或.uis文件生成可部署的.zip包。
publish租户订阅源将打包的.zip上传到 UiPath 解决方案订阅源。
uploadStudio Web上传解决方案,以便在 Studio Web 中进行基于浏览器的编辑。
deleteStudio Web按 ID 删除 Studio Web 解决方案。
packages租户订阅源列出和删除已发布的解决方案包。
deployOrchestrator运行部署、检查状态、激活、卸载和编辑部署配置文件。

uip solution@uipath/solution-tool插件提供。如果尚未安装, uip tools install solution会进行添加。请参阅工具(插件)

大纲

uip solution new <solutionName>
uip solution project add <projectPath> [solutionFile]
uip solution project import --source <path> [--solutionFile <path>]
uip solution project remove <projectPath> [solutionFile]
uip solution resource list [solutionPath] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resource refresh [solutionPath]

uip solution pack <solutionPath> <outputPath> [--name <name>] [--version <version>]
uip solution publish <packagePath> [--tenant <tenant-name>]
uip solution upload <solutionPath>
uip solution delete <solution-id>

uip solution packages list [--take <n>] [--order-by <column>] [--order-direction <dir>]
uip solution packages delete <packageName> <packageVersion>

uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--folder-path <path>] [--config-file <path>]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--take <n>]
uip solution deploy uninstall <deployment-name>
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>]
uip solution deploy config set <file> [--all] <args...>
uip solution deploy config link <file> <resource> --name <n> [--folder-path <path>]
uip solution deploy config unlink <file> <resource>
uip solution new <solutionName>
uip solution project add <projectPath> [solutionFile]
uip solution project import --source <path> [--solutionFile <path>]
uip solution project remove <projectPath> [solutionFile]
uip solution resource list [solutionPath] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resource refresh [solutionPath]

uip solution pack <solutionPath> <outputPath> [--name <name>] [--version <version>]
uip solution publish <packagePath> [--tenant <tenant-name>]
uip solution upload <solutionPath>
uip solution delete <solution-id>

uip solution packages list [--take <n>] [--order-by <column>] [--order-direction <dir>]
uip solution packages delete <packageName> <packageVersion>

uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--folder-path <path>] [--config-file <path>]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--take <n>]
uip solution deploy uninstall <deployment-name>
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>]
uip solution deploy config set <file> [--all] <args...>
uip solution deploy config link <file> <resource> --name <n> [--folder-path <path>]
uip solution deploy config unlink <file> <resource>

每个子命令都遵循全局选项--output--output-filter--log-level--log-file ),并返回标准退出代码。默认输出为JSON

端到端流程

┌──────────┐   ┌────────────┐   ┌──────────┐   ┌──────────────┐   ┌──────────────────┐
│ solution │   │ solution   │   │ solution │   │ solution     │   │ solution deploy  │
│ new      │ → │ project    │ → │ pack     │ → │ publish      │ → │ run              │
│          │   │ add/import │   │          │    (tenant feed) (Orchestrator)   │
└──────────┘   └────────────┘   └──────────┘   └──────────────┘   └──────────────────┘
┌──────────┐   ┌────────────┐   ┌──────────┐   ┌──────────────┐   ┌──────────────────┐
│ solution │   │ solution   │   │ solution │   │ solution     │   │ solution deploy  │
│ new      │ → │ project    │ → │ pack     │ → │ publish      │ → │ run              │
│          │   │ add/import │   │          │   │ (tenant feed)│   │ (Orchestrator)   │
└──────────┘   └────────────┘   └──────────┘   └──────────────┘   └──────────────────┘
  1. 框架。uip solution new my-solution将创建一个包含空.uipx清单文件的目录。
  2. 填充。uip solution project add ./my-solution/my-project ./my-solution/my-solution.uipx注册项目子文件夹,或uip solution project import --source ./external --solutionFile ./my-solution/my-solution.uipx在其中复制外部项目。
  3. 包。 uip solution pack ./my-solution ./dist --version 1.0.0生成./dist/my-solution.1.0.0.zip
  4. 发布。uip solution publish ./dist/my-solution.1.0.0.zip.zip上传到租户解决方案订阅源。
  5. 部署。uip solution deploy run --name my-deployment --package-name my-solution --package-version 1.0.0 --folder-name MySolution --folder-path Shared将创建 Orchestrator 文件夹,配置资源(队列、资产、流程),并激活解决方案。

对于交互式创作,请用uip solution upload ./my-solution替换步骤 3,以在UiPath Studio Web中打开解决方案,而不是将其打包以进行部署。

此流程的每个步骤都记录在上方动词分类表中链接的页面上。完整的运行示例位于“您的第一个管道”中。

身份验证

所有与 Orchestrator 进行交互的命令( publishuploaddeletepackages listpackages delete和每个deploy …子命令)都需要活动会话。运行uip login一次;在任何子命令上传递-t, --tenant <tenant-name> ,以定位经过身份验证的组织中的特定租户。请参阅身份验证

本地命令( newproject add/import/removepackresource list/refresh )对磁盘上的文件离线运行。

另请参阅

  • 您的第一个管道— 动手演示包 → 发布 → 部署运行。
  • 工具(插件) — 解决方案工具的分发方式和版本控制方式。
  • 身份验证配置— 会话设置和每个租户的默认值
  • 全局选项退出代码— 由每个动词共享的合同。
  • uip resource — Orchestrator 资源 CRUD(资产、存储桶、队列、库、触发器、Webhook)。不要与uip solution resource混淆,后者检查本地解决方案资源声明。
  • 动词分类
  • 大纲
  • 端到端流程
  • 身份验证
  • 另请参阅

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新