执行任务

在专为 Windows 设备设计的 UiPath CLI (UiPath.CLI.Windows) 中运行任务需要执行多个任务。

UiPath.CLI.Windows 过程与 UiPath.CLI （专为 Linux 设备设计的 UiPath CLI）过程之间的主要区别在于您可以在某些特定于您所使用的设备类型的任务中传递这些参数继续运行。

重要提示：

使用 UiPath CLI 时，必须确保已在 Studio 中关闭项目。否则会导致冲突，从而在 CLI 中显示以下错误消息：The action could not be performed because the project is already opened in another Studio instance. Please close it and try again.

API 访问应用程序作用域

下表显示了运行任何 CLI 任务所需的 Orchestrator API 访问应用程序作用域。

应用程序作用域	描述
OR. 资产	在 Orchestrator 中具有资产读取和写入权限。
OR.BackgroundTasks	在 Orchestrator 中的后台任务读取和写入权限。
OR. 执行	在 Orchestrator 中具有执行读取和写入权限。
OR. 文件夹	在 Orchestrator 中具有文件夹读取和写入权限。
OR. 作业	在 Orchestrator 中具有作业读取和写入权限。
OR. 计算机. 读取	在 Orchestrator 中具有计算机读取权限。
或. 监控	在 Orchestrator 中具有监控读取和写入权限。
OR.Robots.Read	Orchestrator 中的机器人具有读取权限。
OR.设置.读取	在 Orchestrator 中具有设置读取权限。
OR.测试集	在 Orchestrator 中具有测试集读取和写入权限。
OR.TestSet 执行次数	在 Orchestrator 中具有测试集执行读取和写入权限。
OR.TestSet 计划	测试集计划在 Orchestrator 中具有读取和写入权限。
OR.Users.Read	在 Orchestrator 中具有用户读取权限。

除了表中列出的作用域外，要突出显示的一个重要作用域是OR.Default 。 OR.Default作用域充当通配符。 它在组织级别和文件夹级别提供特定于角色的精细访问权限。 这使您可以灵活地对应用程序权限进行精确控制，超出了预定义的组织范围权限。 有关更多详细信息，请参阅声明作用域。

Running UiPath.CLI.Windows

先决条件：要使用适用于 Windows 的 UiPath CLI 并执行任务，请安装 .NET 6.0.7，其中必须包含6.0.302 SDK 随附的 .NET 6.0.7 Desktop Runtime 。

您可以通过调用包含相应参数的uipcli.exe来执行任务。 要执行子任务，该命令需要具有以下格式： uipcli.exe <task name> <sub-task name> 。 要运行 CLI，请执行以下操作：

1. 打开命令提示符并导航到从 NUPKG 文件中提取的文件夹。
2. 键入uipcli.exe ，然后选择 Enter 键。

运行 UiPath.CLI

先决条件：要使用适用于跨平台的 UiPath CLI 并执行作业任务，请安装6.0.302 SDK随附的 .NET 6.0.7 。

您可以通过调用包含相应参数的uipcli.exe来执行任务。 要执行子任务，该命令需要具有以下格式： dotnet uipcli.dll <task name> <sub-task name> 。 要运行 CLI，请执行以下操作：

1. 打开命令提示符并导航到从 NUPKG 文件中提取的文件夹。
2. 输入 dotnet uipcli.dll，然后按“Enter”。

显示 CLI 版本

运行 uipcli --version 命令。

从 Orchestrator 中删除资产

先决条件：

• 在 Orchestrator 中创建资产。
• 创建一个 CSV 文件，其中包含要删除的资产。 CSV 文件必须包含以下列三列： name 、 type和value 。 type和value列下的数据单元格可以留空。
• 运行 CLI exe （适用于 Windows）或dll （适用于 Linux）文件。
• 添加所需的 Orchestrator API 访问应用程序作用域。

有关 CSV 文件的更多信息，请查看下表中的示例：

name	类型	值
asset1_name	N/A	N/A
asset2_name	Bool	true
asset3_name	整数	N/A
asset4_name	凭据	username:password

要从 Orchestrator 中删除资产，请执行以下操作：

1. 使用uipcli asset运行asset任务。 您可以查看可用子任务的列表。
2. 指定所需参数并运行delete子任务。

   请参阅下面的参数列表。

   参数	描述
   -u,或--username （如果使用 基本身份验证，则为必需，通过用户名和密码）	用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。
   -p 或 --password（如果您通过用户名和密码使用基本身份验证	用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。
   -t或--token （如果使用 基于令牌的身份验证，则为必需）	用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。
   -a或--accountName （如果使用 基于令牌的身份验证，则为必需）	Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。
   -A 或 --accountForApp	Orchestrator CloudRPA 帐户名称（组织名称）。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对。
   -I或--applicationId （如果使用 外部应用程序身份验证，则为必需）	外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。
   -S或--applicationSecret （如果使用 外部应用程序身份验证，则为必需）	外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。
   --applicationScope（如果使用外部应用程序身份验证，则为必填项）	应用程序作用域列表，以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对
   -o 或 --organizationUnit	Orchestrator 文件夹（组织单元）的名称。 要输入子文件夹，请确保同时输入父文件夹的名称和子文件夹的名称。例如，AccountingTeam\TeamJohn。
   -l 或 --language	Orchestrator 用户界面中使用的语言。
   -y 或 --disableTelemetry	禁用遥测数据。
   --traceLevel	显示事件的跟踪。
   --identityUrl （仅 PaaS 部署需要）	身份服务器的 URL。
   --help	显示此命令的参数和示例。
   --version	显示版本信息。
   Assets File (pos. 0)（必填项）	包含要删除的资产的 CSV 文件的名称。
   Orchestrator URL (pos.1)（必填项）	Orchestrator 实例的 URL。
   Orchestrator Tenant (pos.2) （必需）对于 SaaP 部署。 （可选）适用于 PaaS 部署。	要管理资产的 Orchestrator 实例的租户。

用法:

asset delete <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder>] [-l <language>]

示例：

• 资产删除 assets_file.csv "https://uipath-orchestrator.myorg.com" 默认值 -u admin -p 123456 -l en-US
• asset delete assets_file.csv "https://uipath-orchestrator.myorg.com"default -u admin -p 123456 -o OurOrganization
• 资产删除 assets_file.csv "https://uipath-orchestrator.myorg.com" 默认值 -t a7da29a2c93a717110a82 -a myAccount
• 资产删除 assets_file.csv "https://uipath-orchestrator.myorg.com" 默认值 -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"

将资产部署到 Orchestrator

先决条件：

• 创建一个 CSV 文件，其中包含要部署到 Orchestrator 的资产。
  CSV 文件必须包含以下列三列： name 、 type 、 value和description 。
• 运行 CLI exe （适用于 Windows）或dll （适用于 Linux）文件。
• 添加所需的 Orchestrator API 访问应用程序作用域。

有关 CSV 文件的详细信息，请参阅下面的示例。

name	类型	值	描述
asset_1_name	text	“我有意见”	asset_1_description
asset_2_name	整数	1	asset_2_description
asset_3_name	Bool	false	asset_3_description
asset_4_name	凭据	username:password	asset_4_description

要将资产部署到 Orchestrator：

1. 使用uipcli asset运行asset任务。 您可以查看可用子任务的列表。
2. 指定所需参数并运行deploy子任务。

   请参阅下面的参数列表。

   参数	描述
   -u 或 --username（如果您通过用户名和密码使用基本身份验证	用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。
   -p 或 --password（如果您通过用户名和密码使用基本身份验证	用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。
   -t或--token （如果使用 基于令牌的身份验证，则为必需）	用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。
   -a或--accountName （如果使用 基于令牌的身份验证，则为必需）	Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。
   -A 或 --accountForApp	Orchestrator CloudRPA 帐户名称（组织名称）。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对。
   -I或--applicationId （如果使用 外部应用程序身份验证，则为必需）	外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。
   -S或--applicationSecret （如果使用 外部应用程序身份验证，则为必需）	外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。
   --applicationScope（如果使用外部应用程序身份验证，则为必填项）	应用程序作用域列表，以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对
   -o 或 --organizationUnit	Orchestrator 文件夹（组织单元）的名称。 要输入子文件夹，请确保同时输入父文件夹的名称和子文件夹的名称。例如，AccountingTeam\TeamJohn。
   -l 或 --language	Orchestrator 用户界面中使用的语言。
   -y 或 --disableTelemetry	禁用遥测数据。
   --traceLevel	显示事件的跟踪。
   --identityUrl （仅 PaaS 部署需要）	身份服务器的 URL。
   --help	显示此命令的参数和示例。
   --version	显示版本信息。
   Assets File (pos. 0)（必填项）	包含要删除的资产的 CSV 文件的名称。
   Orchestrator URL (pos.1)（必填项）	Orchestrator 实例的 URL。
   Orchestrator Tenant (pos.2) （必需）对于 SaaP 部署。 （可选）适用于 PaaS 部署。	要在其中管理资产的 Orchestrator 实例的租户。

用法:

asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder>] [-l <language>]

示例：

• asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US。
• asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization。
• asset deploy assets_file.csv "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount。
• asset delete assets_file.csv "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"。

在 Orchestrator 中运行作业

• 在 Orchestrator 中创建流程。
• 运行 CLI exe （适用于 Windows）或dll （适用于 Linux）文件。
• 添加所需的 Orchestrator API 访问应用程序作用域。

1. 使用 uipcli job 运行 job 任务。现在，您可以看到可用子任务的列表。
2. 指定所需参数并运行run子任务。
   请参阅下面的参数列表。

   参数	描述
   -i或--input_path （仅当工作流的入口点具有输入参数时才需要 ）	与要运行的流程对应的 JSON 输入文件的完整路径。 JSON 文件格式示例： { "StringArgument_In": "MyConfigurationValue", "IntArgument_In": 1, "DictionaryArgument_In": { "Key1": "Value1", "Key2": "Value2" } }
   -P 或 --priority	要运行作业的优先级:- 低。- 正常（默认）。- 高。
   -r 或 --robots	特定机器人名称的列表，以逗号分隔。
   -j 或 --jobscount	要运行流程的次数。 流程运行的默认次数为 1。
   -U 或 --user	用户名。此用户不可为计算机用户或 Orchestrator 用户。对于本地用户，用户名格式应为“计算机名称\\UserN用户名”。
   -M 或 --machine	要在其上运行流程的计算机的名称。
   -R 或 --result_path	要存储作业结果的 JSON 文件或文件夹的完整路径。 结果以 JSON 文件形式返回。
   -W 或 --timeout	作业执行的超时 (秒)。 默认值为 1800 秒。
   -f 或 --fail_when_job_fails	当一个作业失败时，该命令将失败，默认值为 True。
   -w 或 --wait	该命令等待作业完成。 默认值为 True。
   -b或--job_type （仅适用于新式文件夹）	作业的运行时类型。 您可以选择：- Unattended - NonProduction 。
   -u 或 --username（如果您通过用户名和密码使用基本身份验证	用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。
   -p 或 --password（如果您通过用户名和密码使用基本身份验证	用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。
   -t或--token （如果使用 基于令牌的身份验证，则为必需）	用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。
   -a或--accountName （如果使用 基于令牌的身份验证，则为必需）	Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。
   -A 或 --accountForApp	Orchestrator CloudRPA 帐户名称（组织名称）。 您必须将其与外部应用程序的“应用程序 ID ”、“应用程序密码”和“应用程序作用域”配对。
   -I 或 --applicationId（如果使用外部应用程序身份验证，则为必填项）	外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。
   -S 或 --applicationSecret（如果使用外部应用程序身份验证，则为必填项）	外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。
   --applicationScope（如果使用外部应用程序身份验证，则为必填项）	应用程序作用域列表，以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对
   -o 或 --organizationUnit	Orchestrator 文件夹（组织单元）的名称。 要输入子文件夹，请确保同时输入父文件夹的名称和子文件夹的名称。例如，AccountingTeam\TeamJohn。
   -l, --language	Orchestrator 语言。
   -y, --disableTelemetry	禁用遥测数据。
   --traceLevel	显示事件的跟踪。
   --identityUrl （仅适用于PaaS部署）	身份服务器的 URL。
   --help	显示此命令的参数和示例。
   --version	显示版本信息。
   Process Name (pos.0)（必填项）	要运行的流程的名称。
   Orchestrator URL (pos.1)（必填项）	Orchestrator 实例的 URL。
   Orchestrator Tenant (pos.2) （必需）对于 SaaP 部署。 （可选）适用于 PaaS 部署。	要在其中运行流程的 Orchestrator 实例的租户。

用法:

job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <priority>] [-r <robots>] [-f <do_not_fail_when_job_fails>] [-W <timeout>] [-w <do_not_wait>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder_organization_unit>] [-l <language>]

示例:

• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456

• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Low

• job run ProcessName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -P Normal -o MyFolder

• 作业运行流程名称“https://uipath-orchestrator.myorg.com” 默认值 -u admin -p 123456 -P 高 -o 我的文件夹

• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -f false -W 0

• 作业运行流程名称“https://uipath-orchestrator.myorg.com” 默认值 -t a7da29a2c93a717110a82 -a myAccount -P 高 -j 3 -w false

• job run ProcessName "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount -P Low -r robotName -R C:\Temp

• 作业运行流程名称“https://uipath-orchestrator.myorg.com” 默认值 -t a7da29a2c93a717110a82 -a myAccount -r 机器人名称 -RC:\Temp\status.json

• job run ProcessName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read" -r robotName -R C:\Temp\status.json

分析项目

先决条件：

• 创建项目。
• 运行 CLI exe （适用于 Windows）或dll （适用于 Linux）文件。
• 添加所需的 Orchestrator API 访问应用程序作用域。

1. 使用uipcli package运行package任务。 您可以查看可用子任务的列表。
2. 指定所需参数并运行analyze子任务。

   请参阅下面的参数列表。

备注：

UiPath CLI 的“打包”或“分析”任务不执行项目验证。

图例：(*) - 可选，建议在使用其他包订阅源时使用。

参数	描述
--analyzerTraceLevel	选择分析后要输出的消息类型： 关闭 = 不显示任何消息 错误 -警告 -信息 -详细。
-stopOnRuleViolation	违反任何规则时，作业将失败。
--treatWarningsAsErrors	将警告视为错误。
--resultPath	要存储结果的 JSON 文件的完整路径。 如果不将其添加为参数，则结果将仅在标准控制台中打印。
--ignoredRules	要在分析期间忽略的规则列表，以逗号分隔。
--orchestratorUsername (*) （如果您通过用户名和密码使用基本身份验证，则为必填项）	用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。
--orchestratorPassword (*) （如果您通过用户名和密码使用基本身份验证，则为必填项）	用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。
-orchestratorAuthToken (*) （如果您使用基于令牌的身份验证，则为必填项）	用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。
--orchestratorAccountName (*) （如果您使用基于令牌的身份验证，则为必填项）	Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。
--orchestratorAccountForApp (*)	Orchestrator CloudRPA 帐户名称（组织名称）。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对。
--orchestratorApplicationId (*) （如果使用外部应用程序身份验证，则为必填项）	外部应用程序 ID。您必须将其与**“应用程序帐户”、“应用程序密码”和“应用程序作用域。
--orchestratorApplicationSecret (*) （如果使用外部应用程序身份验证，则为必填项）	外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。
--orchestratorApplicationScope (*) （如果使用外部应用程序身份验证，则为必填项）	应用程序作用域列表，以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对
--orchestratorFolder (*)	目标 Orchestrator 文件夹的名称。 要输入子文件夹，请确保同时输入父文件夹的名称和子文件夹的名称。例如，AccountingTeam\TeamJohn。
--orchestratorUrl (*)	Orchestrator 实例的 URL。
--orchestratorTenant (*)	要删除计算机的 Orchestrator 实例的租户。
-l, --language	Orchestrator 语言。
-y, --disableTelemetry	禁用遥测数据。
--traceLevel	显示事件的跟踪。
-identityUrl （仅 PaaS 部署需要）	身份服务器的 URL。
--disableBuiltInNugetFeeds	禁用内置 NuGet 订阅源。
--help	显示此命令的参数和示例。
--version	显示版本信息。
Project(s) Path (pos.0) (必填)	project.json文件的路径，或包含多个project.json文件的文件夹的路径。

用法:

package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--saveOutputToFile] [--ignoredRules <activity_1_id,activity_2_id,activity_3_id,activity_4_id>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [--orchestratorUsername <orchestrator_user> --orchestratorPassword <orchestrator_pass>] [--orchestratorAuthToken <auth_token> --orchestratorAccountName <account_name>] [--orchestratorFolder <folder>]

示例:

• package analyze "C:\UiPath\Project\project.json"

• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error"

• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation

• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors

• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json"

• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020"

• package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020" --orchestratorUrl "https://orchestratorurl.com" --orchestratorTenant "default" --orchestratorUsername "username" --orchestratorPassword "\_ye5zG9(x" --orchestratorAuthToken "AuthToken" --orchestratorAccountName "AccountName" --orchestratorFolder "OrchestratorFolder"

删除包

先决条件：

• 将包发布到 Orchestrator。
• 运行 CLI exe （适用于 Windows）或dll （适用于 Linux）文件。
• 添加所需的 Orchestrator API 访问应用程序作用域。

1. 使用uipcli package运行package任务。 您可以查看可用子任务的列表。
2. 指定所需参数并运行delete子任务。

   请参阅下面的参数列表。

   参数	描述
   Package name (pos. 0)（必填项）	要删除的包的名称。
   Orchestrator URL (pos. 1)	Orchestrator 实例的 URL。
   Orchestrator Tenant (pos. 2) （必需）对于 SaaP 部署。 （可选）适用于 PaaS 部署。	要删除计算机的 Orchestrator 实例的租户。
   -u 或 --username（如果您通过用户名和密码使用基本身份验证	用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。
   -p 或 --password（如果您通过用户名和密码使用基本身份验证	用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。
   -t或--token （如果使用 基于令牌的身份验证，则为必需）	用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。
   -a或--accountName （如果使用 基于令牌的身份验证，则为必需）	Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。
   -A 或 --accountForApp	Orchestrator CloudRPA 帐户名称（组织名称）。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对。
   -I或--applicationId （如果使用 外部应用程序身份验证，则为必需）	外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。
   -S或--applicationSecret （如果使用 外部应用程序身份验证，则为必需）	外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。
   --applicationScope（如果使用外部应用程序身份验证，则为必填项）	应用程序作用域列表，以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对
   -o 或 --organizationUnit	Orchestrator 文件夹（组织单元）的名称。 要输入子文件夹，请确保同时输入父文件夹的名称和子文件夹的名称。例如，AccountingTeam\TeamJohn。
   -l 或 --language	Orchestrator 用户界面中使用的语言。
   -y 或 --disableTelemetry	禁用遥测数据。
   --traceLevel	显示事件的跟踪。
   --identityUrl （仅 PaaS 部署需要）	身份服务器的 URL。
   --help	显示此命令的参数和示例。

示例：

• package delete PackageName "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -l en-US。
• package delete PackageName "https://uipath-orchestrator.myorg.com" default -t refreshToken -a accountName。
• package delete PackageName "https://uipath-orchestrator.myorg.com" default -A accountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"。

将包部署到 Orchestrator

先决条件：

• 创建包。
• 运行 CLI exe （适用于 Windows）或dll （适用于 Linux）文件。
• 添加所需的 Orchestrator API 访问应用程序作用域。

1. 使用uipcli package运行package任务。 您可以查看可用子任务的列表。
2. 指定所需参数并运行deploy子任务。

   请参阅下面的参数列表。

   参数	描述
   -c 或 --createProcess	的默认值为true 。 当设置为true时，它会在 Orchestrator 文件夹中创建一个在命令中传递的流程。 设置为 false时，它不会在 Orchestrator 文件夹中创建流程。 例如， --createProcess false.
   -e或--environments （适用于传统文件夹）	要将包部署到的环境列表，以逗号分隔。 如果环境不属于默认文件夹（组织单位），则必须在环境名称前加上文件夹名称。 例如，如果环境为 “TestEnvironment”，文件夹名称为“ AccountingTeam”，则将环境写入“ AccountingTeam\TestEnvironment”。
   -h 或 --entryPointsPath	定义用于创建或更新流程的特定入口点。这是始于项目根目录的入口点文件路径。 对于传统文件夹，只能为每个环境指定一个入口点。
   -u 或 --username（如果您通过用户名和密码使用基本身份验证	用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。
   -p 或 --password（如果您通过用户名和密码使用基本身份验证	用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。
   -t或--token （如果使用 基于令牌的身份验证，则为必需）	用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。
   -a或--accountName （如果使用 基于令牌的身份验证，则为必需）	Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。
   -A 或 --accountForApp	Orchestrator CloudRPA 帐户名称（组织名称）。 您必须将其与外部应用程序的“应用程序 ID ”、“应用程序密码”和“应用程序作用域”配对
   -I或--applicationId （如果使用 外部应用程序身份验证，则为必需）	外部应用程序 ID。 您必须将其与“ 应用程序帐户”、“应用程序密码”和“ 应用程序作用域”配对。
   -S或--applicationSecret （如果使用 外部应用程序身份验证，则为必需）	外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。
   --applicationScope（如果使用外部应用程序身份验证，则为必填项）	应用程序作用域列表，以单个空格分隔。 您必须将其与外部应用程序的 应用程序帐户、应用程序 ID和 应用程序密码 配对。
   -o 或 --organizationUnit	Orchestrator 文件夹（组织单元）的名称。 要输入子文件夹，请确保同时输入父文件夹的名称和子文件夹的名称。例如，AccountingTeam/TeamJohn。
   -l 或 --language	Orchestrator 用户界面中使用的语言。
   -y 或 --disableTelemetry	禁用遥测数据。
   --traceLevel	显示事件的跟踪。
   --identityUrl （仅 PaaS 部署需要）	身份服务器的 URL。
   --help	显示此命令的参数和示例。
   --version	显示版本信息。
   Package(s) Path (pos. 0)（必填项）	包文件的路径，或包含多个包的文件夹的路径。
   Orchestrator URL (pos. 1)（必填项）	Orchestrator 实例的 URL。
   Orchestrator 租户 (pos.2) （必需）对于 SaaP 部署。 （可选）适用于 PaaS 部署。	要删除计算机的 Orchestrator 实例的租户。

如果未指定入口点，则 uipcli 将创建一个具有 default 入口点的流程。如果指定了入口点，则系统将创建具有该入口点的流程，并将 _{entryPoint} 附加到流程名称。此外，与 package.Id 关联的所有流程都将更新为最新版本，无论流程是手动创建还是通过管道创建。

用法:

package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-o <folder_organization_unit>] [-c <create_process>] [-e <environment_list>] [-l <language>]

示例：

• package deploy "C:\UiPath\Project 1" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456

• package deploy "C:\UiPath\Project\Package.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -o OurOrganization

• package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-US

• package deploy "C:\UiPath\Project\Package.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -t a7da29a2c93a717110a82 -a myAccount

• package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -A myAccountForExternalApp -I myExternalAppId -S myExternalAppSecret --applicationScope "OR.Folders.Read OR.Settings.Read"

• package deploy "C:\UiPath\Project\TestsPackage.1.0.6820.22047.nupkg" "https://uipath-orchestrator.myorg.com" default -u admin -p 123456 -e SAPEnvironment,ExcelAutomationEnvironment -l en-US -h EntryPoint1,EntryPoint2

将项目打包到包中

先决条件：

• 创建项目。
• 运行 CLI exe （适用于 Windows）或dll （适用于 Linux）文件。
• 添加所需的 Orchestrator API 访问应用程序作用域。

1. 使用uipcli package运行package任务。 您可以查看可用子任务的列表。
2. 指定所需参数并运行pack子任务。

   请参阅下面的参数列表。

备注：

UiPath CLI 的“打包”或“分析”任务不执行项目验证。

图例：(*) - 可选，仅当您在 Orchestrator 中具有库的依赖项时才有用。

参数	描述
-o 或 --output（必填项）	要在其中打包项目的目标 Orchestrator 文件夹。
-v 或 --version	设置包版本。
--autoVersion	自动生成包版本。
--outputType	强制输出为指定的类型。
--splitOutput	启用到运行时库和设计库的输出拆分。
--repositoryUrl	项目进行版本控制时所在的存储库 URL。
--repositoryCommit	从中提交构建项目的存储库。
--repositoryBranch	从中构建项目的存储库分支。
--repositoryType	VCS 系统存储库类型。
--projectUrl	Automation Hub 概念 URL。
--releaseNotes	添加发行说明。
--libraryOrchestratorUsername (*) （如果您通过用户名和密码使用基本身份验证，则为必填项）	用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。 如果您的包引用 Orchestrator 订阅源中的库，则这是必需的
--libraryOrchestratorPassword (*) （如果您通过用户名和密码使用基本身份验证，则为必填项）	用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。 如果您的包引用 Orchestrator 订阅源中的库，则这是必需的
--libraryOrchestratorAuthToken (*) （如果您使用基于令牌的身份验证，则为必填项）	用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。 如果您的包引用 Orchestrator 订阅源中的库，则这是必需的
--libraryOrchestratorAccountName (*) （如果您使用基于令牌的身份验证，则为必填项）	Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。 如果您的包引用 Orchestrator 订阅源中的库，则这是必需的
--libraryOrchestratorAccountForApp (*)	Orchestrator CloudRPA 帐户名称（组织名称）。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对 如果包从 Orchestrator 订阅源引用库，则这是必需的。
--libraryOrchestratorApplicationId (*) （如果使用外部应用程序身份验证，则为必填项）	外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。 如果包从 Orchestrator 订阅源引用库，则这是必需的。
--libraryOrchestratorApplicationSecret (*) （如果使用外部应用程序身份验证，则为必填项）	外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。 如果包从 Orchestrator 订阅源引用库，则这是必需的。
--libraryOrchestratorApplicationScope (*) （如果使用外部应用程序身份验证，则为必填项）	应用程序作用域列表，以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对 如果包从 Orchestrator 订阅源引用库，则这是必需的。
--libraryOrchestratorFolder (*)	目标 Orchestrator 文件夹的名称。 要输入子文件夹，请确保同时输入父文件夹的名称和子文件夹的名称。例如，AccountingTeam\TeamJohn。
--libraryOrchestratorUrl (*)	Orchestrator 实例的 URL。
--libraryOrchestratorTenant (*)	要删除计算机的 Orchestrator 实例的租户。
--libraryIdentityUrl（仅适用 于 PaaS 部署 ）	身份服务器的 URL。
-y 或 --disableTelemetry	禁用遥测数据。
--traceLevel	显示事件的跟踪。
-l 或 --language	Orchestrator 用户界面中使用的语言。
--disableBuiltInNugetFeeds	禁用内置 NuGet 订阅源。
--help	显示此命令的参数和示例。
--version	显示版本信息。
Project(s) Path (pos. 0) (必填)	project.json文件或包含project.json文件的文件夹的路径。

用法:

package pack <project_path> -o <destination_folder> [-v <version>] [--autoVersion] [--outputType <Process|Library|Tests|Objects>] [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--libraryOrchestratorUsername <orchestrator_user> --libraryOrchestratorPassword <orchestrator_pass>] [--libraryOrchestratorAuthToken <auth_token> --libraryOrchestratorAccountName <account_name>] [--libraryOrchestratorFolder <folder>] [-l <language>]

示例:

• package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package"

• package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" -v 1.0.6820.22047

• package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --autoVersion

• package pack "C:\UiPath\Project" -o "C:\UiPath\Package"

• package pack "C:\UiPath\Project\project.json" -o "C:\UiPath\Package" --outputType Tests -l en-US

测试包/运行测试集

先决条件：

• 创建包或测试集。
• 运行 CLI exe （适用于 Windows）或dll （适用于 Linux）文件。
• 添加所需的 Orchestrator API 访问应用程序作用域。

1. 使用uipcli test运行test任务。 您可以查看可用子任务的列表。
2. 指定所需参数并运行run子任务。

   请参阅下面的参数列表。

   参数	描述
   -P 或 --project-path	要测试的测试包文件的路径。
   -s 或 --testset	要执行的测试集的显示名称。 确保测试集包含最新版本的测试用例。如果测试集不在默认文件夹中，请确保在其前面添加相关文件夹名称。 例如，使用“AccountingTeam\TestSet”。
   --out	结果文件 <junit|uipath> 的类型。
   -r 或 --result_path	要存储结果的文件的目标路径。
   -e或--environment （传统文件夹为必需 ）	要部署包的环境。 您必须将其与project path配对。
   -w 或 --timeout	要等待测试集执行的时间（以秒为单位）。 默认值为 7200 秒。
   -i或--input_path （如果入口点工作流具有要通过命令行传递的输入参数，则为必需 ）	json 输入文件的完整路径。
   --attachRobotLogs	附加每个已执行测试用例的机器人日志和 JUnit 测试报告。
   --repositoryUrl	项目进行版本控制时所在的存储库 URL。
   --repositoryCommit	从中提交构建项目的存储库。
   --repositoryBranch	从中构建项目的存储库分支。
   --repositoryType	VCS 系统存储库类型。
   --projectUrl	Automation Hub 概念 URL。
   --releaseNotes	添加发行说明。
   --disableBuiltInNugetFeeds	禁用内置 NuGet 订阅源。
   --retryCount	失败的测试用例的重试次数。
   -u 或 --username（如果您通过用户名和密码使用基本身份验证	用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。
   -p 或 --password（如果您通过用户名和密码使用基本身份验证	用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。
   -t或--token （如果使用 基于令牌的身份验证，则为必需）	用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。
   -a或--accountName （如果使用 基于令牌的身份验证，则为必需）	Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。
   -A, --accountForApp	Orchestrator CloudRPA 帐户名称（组织名称）。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对。
   -I或--applicationId （如果使用 外部应用程序身份验证，则为必需）	外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。
   -S或--applicationSecret （如果使用 外部应用程序身份验证，则为必需）	外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。
   --applicationScope（如果使用外部应用程序身份验证，则为必填项）	应用程序作用域列表，以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对
   -o 或 --organizationUnit	要在其中执行测试集的 Orchestrator 文件夹。
   -l 或 --language	Orchestrator 用户界面中使用的语言。
   -y 或 --disableTelemetry	禁用遥测数据。
   --traceLevel	显示事件的跟踪。
   --identityURL （仅 PaaS 部署需要 ）	身份服务器的 URL。
   --help	显示此命令的参数和示例。
   --version	显示版本信息。
   Orchestrator URL (pos. 0)（必填项）	Orchestrator 实例的 URL。
   Orchestrator Tenant (pos. 1) （必需）对于 SaaP 部署。 （可选）适用于 PaaS 部署。	包或测试集所在的租户。

用法:

test run <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-P <package>] [-s <testset>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <account_for_app> -I <application_id> -S <application_secret> --applicationScope] [-e <environment>] [-o <folder_organization_unit>] [-l <language>]

示例：

• test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

• test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

• test run "https://automation-suite.base.url.com/" "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json"

• test run "https://cloud.uipath.com/" "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --applicationScope "OR.Folders OR.BackgroundTasks OR.TestSets OR.TestSetExecutions OR.TestSetSchedules OR.Settings.Read OR.Robots.Read OR.Machines.Read OR.Execution OR.Assets OR.Users.Read OR.Jobs OR.Monitoring" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json

• test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out junit

• test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" --out uipath