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 種類から構成されます。

1. UiPath.CLI.Windows

   • Windows デバイスでのみ動作します。
   • Windows - レガシ プロジェクト、Windows プロジェクト、クロスプラットフォーム プロジェクトをビルドします。

2. UiPath.CLI

   • Linux デバイスでのみ動作します。
   • クロスプラットフォーム プロジェクトのみをビルドします。

注:

• UiPath CLI は SSO 接続をサポートしていません。

• UiPath CLI を使用して 、ローカル トリガーを使用するプロジェクトを構築することはできません。

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

前提条件

• UiPath.CLI の場合は、6.0.302 SDK に付属する .NET 6.0.7 かそれ以降のバージョンをインストールします。
• UiPath.CLI.Windows の場合は、.NET 6.0.7 以降をインストールします。また、.NET SDK に付属する .NET Desktop Runtime もインストールする必要があります。

CLI をダウンロードする

UiPath CLI の任意のバージョンを UiPath のオフィシャル パブリック フィードからダウンロードできます。お使いのプロジェクトに適したバージョンを確認するには、以下の相互運用性マトリクスをご覧ください。

1. UiPath のオフィシャル パブリック フィードに移動します。
2. [Filter by keywords] の検索バーに「uipath.cli」と入力します。
3. 以下のいずれかのオプションを選択します。
   • UiPath.CLI
   • UiPath.CLI.Windows
4. [Versions] タブに移動し、ダウンロードする CLI のバージョンを選択します。
5. [Download] を選択します。
6. 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
クラウド	クロスプラットフォーム

CLI で使用される NuGet フィードを制御する

組み込みの 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 (このパスが現在のエージェント上にある場合)

組み込みフィードを使用しない uipcli を指定するには、 --disableBuiltInNugetFeeds パラメーターを設定します。 このパラメーターは、 analyze、 pack、および test runタスクに使用できます。

構成ファイルを使用して uipcli を実行する場合は、 "disableBuiltInNugetFeeds": trueを設定します。

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

自動化をパッケージ化するときにカスタム フィードを使用できます。 これを行うには、次のことを行う必要があります。

1. 次の形式のカスタム nuget.config ファイルを作成します。

   <?xml version="1.0" encoding="utf-8"?>
   <configuration>
     <packageSources>
       <add key="test custom feed" value="custom_feed_url" />
     </packageSources>
   </configuration>

2. カスタム 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'

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()
                )
            }
        }
    }
}