- 发行说明
- 简介
- 监管
- 源代码控件
- CI/CD 管道
- 订阅源管理
- 日志记录
UiPath CLI
UiPath 提供了一个命令行界面 (CLI),允许您执行某些预定义任务,以进行 RPA 包管理和测试。 UiPath CLI 的目的是在无需插件的情况下轻松地将这些功能与第三方工具(如 GitLab、Jenkins 等)集成。
UiPath CLI 可以与通过 Automation Cloud、Automation Suite 部署的 Orchestrator 一起使用,也可以独立使用。
UiPath CLI 的常见用例包括:
- 将 Studio 项目打包到 NuGet 包中。
- 正在将 NuGet 包部署到 Orchestrator。
- 在 Orchestrator 中运行作业。
- 在 Orchestrator 中运行测试集。
UiPath CLI 包含两种类型:
-
UiPath.CLI.Windows
- 仅在 Windows 设备上运行。
- 构建 Windows - Legacy、Windows和 跨平台 项目。
-
UiPath.CLI
- 仅在 Linux 设备上运行。
- 仅构建 跨平台 项目。
- 对于 UiPath.CLI,请安装附带 6.0.302 SDK 的 .NET 6.0.7 或更高版本。
- 对于 UiPath.CLI.Windows,请安装 .NET 6.0.7 或更高版本。您还必须安装附带 .NET SDK 的 .NET Desktop Runtime。
您可以从 UiPath 官方公共订阅源中下载任意版本的 UiPath CLI,要找到适合您项目的版本,请查看下面的兼容性矩阵。
uipcli.exe
(对于 UiPath.CLI.Windows)或uipcli.dll
(对于 UiPath.CLI),位于tools
文件夹中。
您用于创建项目的 UiPath Studio 版本需要与 UiPath.CLI.Windows 的版本匹配。
图例: - 兼容; - 不兼容。
Orchestrator |
项目类型 |
UiPath.CLI.Windows 23.10 |
UiPath.CLI.Windows 23.6 |
UiPath.CLI.Windows 22.10 |
---|---|---|---|---|
版本 2023.10.x PaaS | Windows - 旧版 |
|
|
|
版本 2023.10.x PaaS | Windows |
|
|
|
版本 2023.10.x PaaS | 跨平台 |
|
|
|
2021.10.x内部部署 |
Windows - 旧版 |
|
|
|
2021.10.x内部部署 |
Windows |
|
|
|
2021.10.x内部部署 |
跨平台 |
|
|
|
2021.10.xPaaS |
Windows - 旧版 |
|
|
|
2021.10.xPaaS |
Windows |
|
|
|
2021.10.xPaaS |
跨平台 |
|
|
|
2022.4.x |
Windows - 旧版 |
|
|
|
2022.4.x |
Windows |
|
|
|
2022.4.x |
跨平台 |
|
|
|
2022.10.x |
Windows - 旧版 |
|
|
|
2022.10.x |
Windows |
|
|
|
2022.10.x |
跨平台 |
|
|
|
2023.4.x | Windows - 旧版 |
|
|
|
2023.4.x | Windows |
|
|
|
2023.4.x | 跨平台 |
|
|
|
Cloud |
Windows - 旧版 |
|
|
|
Cloud |
Windows |
|
|
|
Cloud |
跨平台 |
|
|
|
您用于创建项目的 UiPath Studio 的版本需要与 UiPath.CLI 的版本匹配。 例如,如果您使用 UiPath Studio 2021.10 创建项目, 您需要使用 21.10 版本的 UiPath.CLI。
图例: - 兼容; - 不兼容。
Orchestrator | 项目类型 | UiPath.CLI 23.10 | UiPath.CLI 23.6 | UiPath.CLI 22.10 | UiPath.CLI 22.4 | UiPath.CLI 21.10 |
---|---|---|---|---|---|---|
版本 2023.10.x PaaS | Windows - 旧版 |
|
|
|
|
|
版本 2023.10.x PaaS | Windows |
|
|
|
|
|
版本 2023.10.x PaaS | 跨平台 |
|
|
|
|
|
2021.10.x内部部署 |
Windows - 旧版 |
|
|
|
|
|
2021.10.x内部部署 |
Windows |
|
|
|
|
|
2021.10.x内部部署 |
跨平台 |
|
|
|
|
|
2021.10.xPaaS |
Windows - 旧版 |
|
|
|
|
|
2021.10.xPaaS |
Windows |
|
|
|
|
|
2021.10.xPaaS |
跨平台 |
|
|
|
|
|
2022.4.x |
Windows - 旧版 |
|
|
|
|
|
2022.4.x |
Windows |
|
|
|
|
|
2022.4.x |
跨平台 |
|
|
|
|
|
2022.10.x |
Windows - 旧版 |
|
|
|
|
|
2022.10.x |
Windows |
|
|
|
|
|
2022.10.x |
跨平台 |
|
|
|
|
|
2023.4.x | Windows - 旧版 |
|
|
|
|
|
2023.4.x | Windows |
|
|
|
|
|
2023.4.x | 跨平台 |
|
|
|
|
|
Cloud |
Windows - 旧版 |
|
|
|
|
|
Cloud |
Windows |
|
|
|
|
|
Cloud |
跨平台 |
|
|
|
|
|
uipcli
searches for dependencies in the following built-in feeds:
-
C:\Program Files\Microsoft SDKs\NuGetPackages
(if this path is on the current agent) -
C:\Program Files (x86)\Microsoft SDKs\NuGetPackages
(if this path is on the current agent)
uipcli
to not use the built-in feeds by setting the --disableBuiltInNugetFeeds
parameter. This parameter can be passed to the following tasks: analyze
, pack
, and test run
.
uipcli
with a configuration file, set "disableBuiltInNugetFeeds": true
.
You can use custom feeds when packing an automation. To do this, you need to:
-
Create a custom
nuget.config
file with the following format:<?xml version="1.0" encoding="utf-8"?> <configuration> <packageSources> <add key="test custom feed" value="custom_feed_url" /> </packageSources> </configuration>
<?xml version="1.0" encoding="utf-8"?> <configuration> <packageSources> <add key="test custom feed" value="custom_feed_url" /> </packageSources> </configuration> -
Place the custom
nuget.config
file in the folder whereuipcli
is cached:
Using custom nuget.config in Azure DevOps
nuget.config
to $(Agent.ToolsDirectory)/uipcli
, after the InstallPlatform
step, as shown in the following example:
trigger:
- main
pool:
vmImage: ubuntu-latest
stages:
- stage: Demo
jobs:
- job: Demo
steps:
- task: UiPathInstallPlatform@4
inputs:
cliVersion: 'X_23.6.8581.19168'
- task: CopyFiles@2
inputs:
SourceFolder: '$(Build.SourcesDirectory)'
Contents: 'nuget.config'
TargetFolder: '$(Agent.ToolsDirectory)/uipcli'
- task: UiPathPack@4
inputs:
versionType: 'AutoVersion'
projectJsonPath: '$(Build.SourcesDirectory)/AutomationProjects/CrossPlatform/VB/ProjectWithCustomLibraryFromOrchestrator_CrossPlatform_VB/project.json'
outputPath: '$(Build.ArtifactStagingDirectory)/Output'
traceLevel: 'Information'
trigger:
- main
pool:
vmImage: ubuntu-latest
stages:
- stage: Demo
jobs:
- job: Demo
steps:
- task: UiPathInstallPlatform@4
inputs:
cliVersion: 'X_23.6.8581.19168'
- task: CopyFiles@2
inputs:
SourceFolder: '$(Build.SourcesDirectory)'
Contents: 'nuget.config'
TargetFolder: '$(Agent.ToolsDirectory)/uipcli'
- task: UiPathPack@4
inputs:
versionType: 'AutoVersion'
projectJsonPath: '$(Build.SourcesDirectory)/AutomationProjects/CrossPlatform/VB/ProjectWithCustomLibraryFromOrchestrator_CrossPlatform_VB/project.json'
outputPath: '$(Build.ArtifactStagingDirectory)/Output'
traceLevel: 'Information'
Using custom nuget.config in Jenkins
nuget.config
to ${WORKSPACE}/CLI
, after the InstallPlatform
step, as shown in the following example:
pipeline {
agent {
label 'plugins-jenkins-lts-agent-01'
}
stages {
stage('Clone') {
steps {
git (
branch: 'main',
url: 'https://github.com/al3xandru-uipath-qa/CI-Plugins-Customer-Support.git'
)
}
}
stage('Install Platform') {
steps {
UiPathInstallPlatform (
traceLevel: 'Information'
)
}
}
stage('Copy nuget.config') {
steps {
bat 'copy nuget.config CLI\\nuget.config'
}
}
stage('Pack') {
steps {
UiPathPack (
outputPath: '${WORKSPACE}/Output',
projectJsonPath: '${WORKSPACE}/AutomationProjects/CrossPlatform/VB/ProjectWithCustomLibraryFromOrchestrator_CrossPlatform_VB/project.json',
traceLevel: 'Information',
version: AutoVersion()
)
}
}
}
}
pipeline {
agent {
label 'plugins-jenkins-lts-agent-01'
}
stages {
stage('Clone') {
steps {
git (
branch: 'main',
url: 'https://github.com/al3xandru-uipath-qa/CI-Plugins-Customer-Support.git'
)
}
}
stage('Install Platform') {
steps {
UiPathInstallPlatform (
traceLevel: 'Information'
)
}
}
stage('Copy nuget.config') {
steps {
bat 'copy nuget.config CLI\\nuget.config'
}
}
stage('Pack') {
steps {
UiPathPack (
outputPath: '${WORKSPACE}/Output',
projectJsonPath: '${WORKSPACE}/AutomationProjects/CrossPlatform/VB/ProjectWithCustomLibraryFromOrchestrator_CrossPlatform_VB/project.json',
traceLevel: 'Information',
version: AutoVersion()
)
}
}
}
}