About 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 デバイスでのみ動作します。
- クロスプラットフォーム プロジェクトのみをビルドします。

注:

UiPath CLI は SSO 接続をサポートしていません。
UiPath CLI を使用して、ローカルトリガーを使用するプロジェクトを構築することはできません。
UiPath CLI には、パッケージに署名する機能がありません。この機能は、Studio からパッケージをパブリッシュするときに利用できます。この場合、唯一の選択肢は、ビルド後に UiPath CLI を使用してパッケージに署名することです。詳細については、 sign コマンドを参照してください。この署名オプションは、Azure DevOps と Jenkins でも機能します。

前提条件

Here you can verify the compatibility between the CLI version, the required .NET version, and the target Robot version.

CLI version	.NET バージョンが必要	構築されたオートメーションの対象となるロボットのバージョン
24.10	.NET 8	24.10+
23.10	.NET 6	23.10+
23.4	.NET 6	23.4+

For UiPath.CLI.Windows, you must also install .NET Desktop Runtime, that comes with the .NET SDK as well.

Downloading UiPath CLI

You can download any version of the UiPath CLI from the UiPath Official Public Feed.

UiPath のオフィシャルパブリックフィードに移動します。
[Filter by keywords] の検索バーに「uipath.cli」と入力します。
以下のいずれかのオプションを選択します。
- UiPath.CLI - UiPath CLI designed for Linux devices
- UiPath.CLI.Windows - UiPath CLI designed for Windows devices
[Versions] タブに移動し、ダウンロードする CLI のバージョンを選択します。
[Download] を選択します。
NUPKG ファイルをダウンロードしたフォルダーを開き、ファイルを右クリックしてフォルダーに抽出します。

結果: NUPKG ファイルと同じ名前のフォルダーが作成されます。このフォルダーに UiPath CLI の内容が保持されます。すべての操作のエントリポイントは uipcli.exe (UiPath.CLI.Windows の場合) または uipcli.dll (UiPath.CLI の場合) になります。場所は tools フォルダーです。

UiPath.CLI.Windows の相互運用性マトリクス

プロジェクトの作成に使用する 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.CLI の相互運用性マトリクス

プロジェクトの作成に使用する 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
クラウド	クロスプラットフォーム

Managing NuGet feeds

This section describes how you can manage the build-in NuGet feeds. Moreover, it provides information on how you can use custom NuGet feeds according to your specific project requirements.

組み込みの NuGet フィードを無効化する

既定では、 uipcli は以下の組み込みフィードで依存関係を検索します。

https://pkgs.dev.azure.com/uipath/Public.Feeds/_packaging/UiPath-Official/nuget/v3/index.json
https://gallery.uipath.com/api/v2
https://api.nuget.org/v3/index.json
C:\Program Files\Microsoft SDKs\NuGetPackages(このパスが現在のエージェント上にある場合)
C:\Program Files (x86)\Microsoft SDKs\NuGetPackages (このパスが現在のエージェント上にある場合)

You can specify uipcli to not use the built-in feeds by setting the --disableBuiltInNugetFeeds parameter. This parameter can be used to the following tasks: analyze, pack, and test run.When you run uipcli with a configuration file, set "disableBuiltInNugetFeeds": true.

カスタム NuGet フィードを使用する

You can use custom feeds when packing an automation.

Using custom nuget.config in UiPath CLI

To use custom feed, take the following steps:

次の形式のカスタム 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()
                )
            }
        }
    }
}