- リリース ノート
- はじめに
- ガバナンス
- ソース管理
- CI/CD パイプライン
- フィードの管理
- ログ
UiPath CLI について
UiPath® では、特定の定義済みタスクを実行して RPA パッケージの管理やテストを行うことができるコマンド ライン インターフェイス (CLI) を提供しています。 UiPath CLI の目的は、こうした機能を GitLab、Jenkins などのサードパーティ ツールとプラグインなしで簡単に連携させることです。
UiPath CLI は、Automation Cloud™、Automation Suite、またはスタンドアロン経由でデプロイされた Orchestrator で使用できます。
UiPath CLI の一般的なユース ケースは以下のとおりです。
- Studio プロジェクトを NuGet パッケージ化する
- Orchestrator に NuGet パッケージをデプロイする
- Orchestrator 内のジョブを実行する
- Orchestrator 内のテスト セットを実行する
UiPath CLI は、次の 2 種類から構成されます。
-
UiPath.CLI.Windows
- Windows デバイスでのみ動作します。
- Windows - レガシ プロジェクト、Windows プロジェクト、クロスプラットフォーム プロジェクトをビルドします。
-
UiPath.CLI
- Linux デバイスでのみ動作します。
- クロスプラットフォーム プロジェクトのみをビルドします。
ここでは、CLI のバージョン、必要な .NET のバージョン、対象の Robot のバージョンの相互運用性を確認できます。
|
CLI のバージョン |
.NET バージョンが必要 |
構築されたオートメーションの対象となるロボットのバージョン |
|---|---|---|
|
24.10 |
.NET 8 |
24.10+ |
|
23.10 |
.NET 6 |
23.10+ |
|
23.4 |
.NET 6 |
23.4+ |
UiPath CLI の任意のバージョンを UiPath のオフィシャル パブリック フィードからダウンロードできます。
uipcli.exe (UiPath.CLI.Windows の場合) または uipcli.dll (UiPath.CLI の場合) になります。場所は tools フォルダーです。
プロジェクトの作成に使用する UiPath Studio のバージョンは、UiPath.CLI.Windows のバージョンと一致している必要があります。
凡例: - 相互運用性あり、
- 相互運用性なし
|
Orchestrator |
projectType |
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.x PaaS |
Windows - レガシ |
|
|
|
|
2021.10.x PaaS |
Windows |
|
|
|
|
2021.10.x PaaS |
クロスプラットフォーム |
|
|
|
|
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 | クロスプラットフォーム |
|
|
|
|
クラウド |
Windows - レガシ |
|
|
|
|
クラウド |
Windows |
|
|
|
|
クラウド |
クロスプラットフォーム |
|
|
|
プロジェクトの作成に使用する UiPath Studio のバージョンは、UiPath.CLI のバージョンと一致している必要があります。たとえば、v2021.10 の UiPath Studio を使用してプロジェクトを作成する場合は、v21.10 の UiPath.CLI を使用する必要があります。
凡例: - 相互運用性あり、
- 相互運用性なし
| Orchestrator | projectType | 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.x PaaS |
Windows - レガシ |
|
|
|
|
|
|
2021.10.x PaaS |
Windows |
|
|
|
|
|
|
2021.10.x PaaS |
クロスプラットフォーム |
|
|
|
|
|
|
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 | クロスプラットフォーム |
|
|
|
|
|
|
クラウド |
Windows - レガシ |
|
|
|
|
|
|
クラウド |
Windows |
|
|
|
|
|
|
クラウド |
クロスプラットフォーム |
|
|
|
|
|
このセクションでは、組み込みの NuGet フィードを管理する方法について説明します。 さらに、特定のプロジェクト要件に応じてカスタム NuGet フィードを使用する方法についても説明します。
uipcli は以下の組み込みフィードで依存関係を検索します。
-
C:\Program Files\Microsoft SDKs\NuGetPackages(このパスが現在のエージェント上にある場合) -
C:\Program Files (x86)\Microsoft SDKs\NuGetPackages(このパスが現在のエージェント上にある場合)
uipcli を指定するには、 --disableBuiltInNugetFeeds パラメーターを設定します。 このパラメーターは、 analyze、 pack、および test runの各タスクに使用できます。構成ファイルを使用して uipcli を実行する場合は、 "disableBuiltInNugetFeeds": trueに設定します。
オートメーションをパッケージ化する際にカスタム フィードを使用できます。
UiPath CLI でカスタム nuget.config を使用する
カスタム フィードを使用するには、次の手順に従います。
-
次の形式のカスタム
nuget.configファイルを作成します。<?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> -
カスタム
nuget.configファイルを、uipcliがキャッシュされているフォルダーに配置します。
Azure DevOps でカスタム nuget.config を使用する
InstallPlatform手順の後に nuget.config を $(Agent.ToolsDirectory)/uipcliにコピーする必要があります。
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'Jenkins でカスタム nuget.config を使用する
InstallPlatform手順の後に nuget.config を ${WORKSPACE}/CLIにコピーする必要があります。
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()
)
}
}
}
}
