- 发行说明
- 简介
- 监管
- 源代码控件
- CI/CD 管道
- 订阅源管理
- 日志记录
执行任务
在专为 Windows 设备设计的 UiPath CLI (UiPath.CLI.Windows) 中运行任务需要执行多个任务。
UiPath.CLI.Windows 过程与 UiPath.CLI (专为 Linux 设备设计的 UiPath CLI)过程之间的主要区别在于您可以在某些特定于您所使用的设备类型的任务中传递这些参数继续运行。
The action could not be performed because the project is already opened in another Studio instance. Please close it and try again.
下表显示了运行任何 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作用域充当通配符。 它在组织级别和文件夹级别提供特定于角色的精细访问权限。 这使您可以灵活地对应用程序权限进行精确控制,超出了预定义的组织范围权限。 有关更多详细信息,请参阅声明作用域。
先决条件:要使用适用于 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,请执行以下操作:
- 打开命令提示符并导航到从 NUPKG 文件中提取的文件夹。
- 键入
uipcli.exe
,然后选择 Enter 键。
先决条件:要使用适用于跨平台的 UiPath CLI 并执行作业任务,请安装6.0.302 SDK随附的 .NET 6.0.7 。
uipcli.exe
来执行任务。 要执行子任务,该命令需要具有以下格式: dotnet uipcli.dll <task name> <sub-task name>
。 要运行 CLI,请执行以下操作:
- 打开命令提示符并导航到从 NUPKG 文件中提取的文件夹。
- 输入
dotnet uipcli.dll
,然后按“Enter”。
先决条件:
- 在 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 |
|
asset3_name |
整数 | N/A |
asset4_name |
凭据 |
username:password |
要从 Orchestrator 中删除资产,请执行以下步骤:
用法:
uipcli asset delete <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]
uipcli asset delete <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]
最小命令示例:
UiPath CLI 资产删除“C:\userprofile\assets.csv” “https://orch-23-10-paas.cloudapp.azure.com/” "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName"--traceLevel "Information"
UiPath CLI 资产删除“C:\userprofile\assets.csv” “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/身份" -o "FolderName" --traceLevel "Information"
UiPath CLI 资产删除“C:\userprofile\assets.csv” "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"
UiPath CLI 资产删除“C:\userprofile\assets.csv” "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"
先决条件:
- 创建一个 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 |
整数 |
|
asset_2_description |
asset_3_name |
Bool |
|
asset_3_description |
asset_4_name |
凭据 |
username:password |
asset_4_description |
要将资产部署到 Orchestrator,请执行以下步骤:
用法:
uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]
uipcli asset deploy <assets_file> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identity_url>]
最小命令示例:
uipcli 资产部署“C:\userprofile\assets.csv” “https://orch-23-10-paas.cloudapp.azure.com/” "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName"--traceLevel "Information"
uipcli 资产部署“C:\userprofile\assets.csv” “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"
uipcli 资产部署“C:\userprofile\assets.csv” "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
uipcli 资产部署“C:\userprofile\assets.csv” "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"
- 在 Orchestrator 中创建流程。
- 运行 CLI
exe
(适用于 Windows)或dll
(适用于 Linux)文件。 - 添加所需的 Orchestrator API 访问应用程序作用域。
要在 Orchestrator 中运行作业,请执行以下步骤:
用法:
uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <Unattended|NonProduction>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]
uipcli job run <process_name> <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-j <jobscount>] [-R <result_path>] [-P <Low|Normal|High>] [-r <robots>] [-f <false|true>] [-W <timeout>] [-w <false|true>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-l <language>] [--user <machine_user> --machine <machine_host_name>] [--job_type <Unattended|NonProduction>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]
最小命令示例:
-
uipcli job run ProcessName "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel "Information"
-
uipcli job run ProcessName "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"
-
uipcli job run ProcessName "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"
UiPath CLI 作业运行流程名称“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"
先决条件:
- 创建项目。
- 运行 CLI
exe
(适用于 Windows)或dll
(适用于 Linux)文件。 - 添加所需的 Orchestrator API 访问应用程序作用域。
要分析项目,请执行以下步骤:
UiPath CLI 的“打包”或“分析”任务不执行项目验证。
参数 |
描述 |
---|---|
|
选择分析后要输出的消息类型:
|
|
违反任何规则时,作业将失败。 |
|
将警告视为错误。 |
|
要存储结果的 JSON 文件的完整路径。 如果不将其添加为参数,则结果将仅在标准控制台中打印。 |
|
传递包含工作流分析器规则的监管策略。 可以从Automation Ops 监管下载策略,也可以从Studio导出的压缩 zip 文件中提取策略。 备注:
如果您指定使用策略,但策略文件不在上述路径中,则任务将失败。 |
|
要在分析期间忽略的规则列表,以逗号分隔。 |
-u 、 --orchestratorUsername (*)
(如果您通过用户名和密码使用基本身份验证,则为必填项) |
用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。 |
-p 、 --orchestratorPassword (*)
(如果您通过用户名和密码使用基本身份验证,则为必填项) |
用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。 |
-t 、 -orchestratorAuthToken (*)
(如果您使用基于令牌的身份验证,则为必填项) |
用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。 |
-a 、 --orchestratorAccountName (*)
(如果您使用基于令牌的身份验证,则为必填项) |
Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。 |
-A 、 --orchestratorAccountForApp (*)
|
Orchestrator CloudRPA 帐户名称(组织名称)。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对。 |
-I 、 --orchestratorApplicationId (*)
(如果使用外部应用程序身份验证,则为必填项) |
外部应用程序 ID。您必须将其与**“应用程序帐户”、“应用程序密码”和“应用程序作用域。 |
-S 、 --orchestratorApplicationSecret (*)
(如果使用外部应用程序身份验证,则为必填项) |
外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。 |
--orchestratorApplicationScope (*)
(如果使用外部应用程序身份验证,则为必填项) |
应用程序作用域列表,以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对 |
--orchestratorFolder (*)
|
目标 Orchestrator 文件夹的名称。 要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,
AccountingTeam\TeamJohn 。
|
--orchestratorUrl (*)
|
Orchestrator 实例的 URL。 |
--orchestratorTenant (*)
|
要删除计算机的 Orchestrator 实例的租户。 |
-l , --language |
Orchestrator 语言。 |
|
显示事件的跟踪。 |
-identityUrl (仅 PaaS 部署需要)
| 身份服务器的 URL。 |
|
禁用内置 NuGet 订阅源。 |
Project(s) Path (pos.0) (必填)
| project.json 文件的路径,或包含多个project.json 文件的文件夹的路径。
|
用法:
uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds]
uipcli package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--resultPath <result_path>] [--governanceFilePath <governance_file_path>] [--ignoredRules <rule_id_1,rule_id_2>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --orchestratorApplicationScope <application_scope>] [--orchestratorFolder <folder_name>] [-l <language>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>] [--disableBuiltInNugetFeeds]
最小命令示例:
-
uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json"
-
uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"
-
uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName" --identityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"
-
uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://automation-suite.base.url.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName"
-
uipcli package analyze "C:\userprofile\AutomationProject\project.json" --traceLevel Information --resultPath "C:\userprofile\result.json" --orchestratorUrl "https://cloud.uipath.com/" --orchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --orchestratorApplicationScope "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" --orchestratorFolder "FolderName"
先决条件:
- 创建包。
- 运行 CLI
exe
(适用于 Windows)或dll
(适用于 Linux)文件。 - 添加所需的 Orchestrator API 访问应用程序作用域。
要将包部署到 Orchestrator,请执行以下步骤:
uipcli
将创建一个具有 default
入口点的流程。如果指定了入口点,则系统将创建具有该入口点的流程,并将 _{entryPoint}
附加到流程名称。此外,与 package.Id
关联的所有流程都将更新为最新版本,无论流程是手动创建还是通过管道创建。
用法:
uipcli package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-c <false|true>] [-e <environment_list>] [-l <language>] [--ignoreLibraryDeployConflict] [--entryPointsPath <entry_points_path_list>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]
uipcli package deploy <packages_path> <orchestrator_url> <orchestrator_tenant> [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-o <folder_name>] [-c <false|true>] [-e <environment_list>] [-l <language>] [--ignoreLibraryDeployConflict] [--entryPointsPath <entry_points_path_list>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]
最小命令示例:
-
uipcli package deploy "C:\userprofile\AutomationPackages" "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information --entryPointsPath "Main.xaml"
-
uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml"n
-
uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml"
-
uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --processNames "C:\userprofile\processNames.csv"
-
uipcli package deploy "C:\userprofile\AutomationPackage.1.0.171447983.nupkg" "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 --entryPointsPath "Main.xaml" --processName "MyProcessName"
先决条件:
- 创建项目。
- 运行 CLI
exe
(适用于 Windows)或dll
(适用于 Linux)文件。 - 添加所需的 Orchestrator API 访问应用程序作用域。
要将项目打包到包中,请执行以下步骤:
UiPath CLI 的“打包”或“分析”任务不执行项目验证。
图例:(*) - 可选,仅当您在 Orchestrator 中具有库的依赖项时才有用。
参数 |
描述 |
---|---|
-o 或 --output (必填项)
|
要在其中打包项目的目标 Orchestrator 文件夹。 |
-v 或 --version |
设置包版本。 |
|
自动生成包版本。 |
|
强制输出为指定的类型。 |
|
启用到运行时库和设计库的输出拆分。 |
|
项目进行版本控制时所在的存储库 URL。 |
|
从中提交构建项目的存储库。 |
|
从中构建项目的存储库分支。 |
|
VCS 系统存储库类型。 |
|
Automation Hub 概念 URL。 |
|
添加发行说明。 |
-u 、 --libraryOrchestratorUsername (*)
(如果您通过用户名和密码使用基本身份验证,则为必填项) |
用于向 Orchestrator 进行身份验证的用户名。 您必须将其与相应的密码配对。 如果您的包引用 Orchestrator 订阅源中的库,则这是必需的 |
-p 、 --libraryOrchestratorPassword (*)
(如果您通过用户名和密码使用基本身份验证,则为必填项) |
用于对 Orchestrator 进行身份验证的密码。您必须将其与相应的用户名配对。 如果您的包引用 Orchestrator 订阅源中的库,则这是必需的 |
-t 、 --libraryOrchestratorAuthToken (*)
(如果您使用基于令牌的身份验证,则为必填项) |
用于对 Orchestrator 进行身份验证的 OAuth2 刷新令牌 。 您必须将其与 Account Name 和 Client ID配对。 如果您的包引用 Orchestrator 订阅源中的库,则这是必需的 |
-a 、 --libraryOrchestratorAccountName (*)
(如果您使用基于令牌的身份验证,则为必填项) |
Orchestrator CloudRPA 帐户名称。 您必须将其与 OAuth2 刷新令牌 和 客户端 ID配对。 如果您的包引用 Orchestrator 订阅源中的库,则这是必需的 |
-A 、 --libraryOrchestratorAccountForApp (*)
|
Orchestrator CloudRPA 帐户名称(组织名称)。您必须将其与外部应用程序的应用程序 ID、应用程序密码和应用程序作用域配对 如果包从 Orchestrator 订阅源引用库,则这是必需的。 |
-I 、 --libraryOrchestratorApplicationId (*)
(如果使用外部应用程序身份验证,则为必填项) | 外部应用程序 ID。您必须将其与“应用程序帐户”、“应用程序密码”和“应用程序作用域”配对。
如果包从 Orchestrator 订阅源引用库,则这是必需的。 |
-S 、 --libraryOrchestratorApplicationSecret (*)
(如果使用外部应用程序身份验证,则为必填项) |
外部应用程序密码。您必须将其与“应用程序帐户”、“应用程序 ID”和“应用程序作用域”配对。 如果包从 Orchestrator 订阅源引用库,则这是必需的。 |
--libraryOrchestratorApplicationScope (*)
(如果使用外部应用程序身份验证,则为必填项) |
应用程序作用域列表,以单个空格分隔。您必须将其与外部应用程序的应用程序账号、应用程序 ID 和应用程序密码配对 如果包从 Orchestrator 订阅源引用库,则这是必需的。 |
--libraryOrchestratorFolder (*)
|
目标 Orchestrator 文件夹的名称。 要输入子文件夹,请确保同时输入父文件夹的名称和子文件夹的名称。例如,
AccountingTeam\TeamJohn 。
|
--libraryOrchestratorUrl (*)
|
Orchestrator 实例的 URL。 |
--libraryOrchestratorTenant (*)
|
要删除计算机的 Orchestrator 实例的租户。 |
--libraryIdentityUrl (仅适用 于 PaaS 部署 )
| 身份服务器的 URL。 |
|
显示事件的跟踪。 |
-l 或 --language |
Orchestrator 用户界面中使用的语言。 |
|
禁用内置 NuGet 订阅源。 |
Project(s) Path (pos. 0) (必填)
| project.json 文件或包含project.json 文件的文件夹的路径。
|
用法:
uipcli package pack <project_path> -o <destination_folder> [-v <version>] [--autoVersion] [--outputType <Process|Library|Tests|Objects>] [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--splitOutput] [--repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]
uipcli package pack <project_path> -o <destination_folder> [-v <version>] [--autoVersion] [--outputType <Process|Library|Tests|Objects>] [--libraryOrchestratorUrl <orchestrator_url> --libraryOrchestratorTenant <orchestrator_tenant>] [--u <orchestrator_user> --p <orchestrator_pass>] [--t <auth_token> --a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --libraryOrchestratorApplicationScope <application_scope>] [--libraryIdentityUrl <identity_url>] [--libraryOrchestratorFolder <folder_name>] [-l <language>] [--splitOutput] [--repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>]
示例:
-
uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output"
-
uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -u "orchestratorUsername" -p "********" --orchestratorFolder "FolderName"
-
uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://orch-23-10-paas.cloudapp.azure.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "76000552-3e4f-4590-9317-cdb420001f1d" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName" --libraryIdentityUrl "https://orch-23-10-paas.cloudapp.azure.com/identity"
-
uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://automation-suite.base.url.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "3f6239b9-e0e8-465e-a429-d9ffd1d9e57a" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"
-
uipcli package pack "C:\userprofile\AutomationProject\project.json" --traceLevel Information -o "C:\userprofile\Packages\Output" --libraryOrchestratorUrl "https://cloud.uipath.com/" --libraryOrchestratorTenant "TenantName" -A "organizationName" -I "becc663c-8f1e-409a-a75f-c00330d80bc8" -S "********" --libraryOrchestratorApplicationScope "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" --libraryOrchestratorFolder "FolderName"
先决条件:
- 创建包或测试集。
- 运行 CLI
exe
(适用于 Windows)或dll
(适用于 Linux)文件。 - 添加所需的 Orchestrator API 访问应用程序作用域。
要测试包,请执行以下步骤:
用法:
uipcli test run <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-P <project_json_path>] [-s <testset_name>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-e <environment>] [-o <folder_name>] [-l <language>] [--out <junit|uipath>] [--result_path <result_path>] [--timeout <seconds>] [--attachRobotLogs true] repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--retryCount <number>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]
uipcli test run <orchestrator_url> <orchestrator_tenant> [-i <input_path>] [-P <project_json_path>] [-s <testset_name>] [-u <orchestrator_user> -p <orchestrator_pass>] [-t <auth_token> -a <account_name>] [-A <organization_name> -I <application_id> -S <application_secret> --applicationScope <application_scope>] [-e <environment>] [-o <folder_name>] [-l <language>] [--out <junit|uipath>] [--result_path <result_path>] [--timeout <seconds>] [--attachRobotLogs true] repositoryUrl <repository_url>] [--repositoryCommit <repository_commit>] [--repositoryBranch <repository_branch>] [--repositoryType <repository_type>] [--projectUrl <automation_hub_idea_url>] [--releaseNotes <release_notes>] [--disableBuiltInNugetFeeds] [--retryCount <number>] [--traceLevel <None|Critical|Error|Warning|Information|Verbose>] [--identityUrl <identityUrl>]
示例:
-
uipcli test run "https://orch-23-10-paas.cloudapp.azure.com/" "TenantName" -u "orchestratorUsername" -p "********" -o "FolderName" --traceLevel Information -P "C:\userprofile\AutomationProjectWithTestCases\project.json" "C:\userprofile\AutomationProjectWithTestCases\project.json"
-
uipcli 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"
-
uipcli 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"
-
uipcli 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"