automation-ops
latest
false
重要 :
このコンテンツの一部は機械翻訳によって処理されており、完全な翻訳を保証するものではありません。
Automation Ops ユーザー ガイド
Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated 2024年10月23日

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 でも機能します。

前提条件

ここでは、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.Windows の場合は、.NET SDK に付属する .NET Desktop Runtime もインストールする必要があります。

UiPath CLI をダウンロードする

  1. UiPath のオフィシャル パブリック フィードに移動します。
  2. [Filter by keywords] の検索バーに「uipath.cli」と入力します。
  3. 以下のいずれかのオプションを選択します。
    • UiPath.CLI - Linux デバイス用に設計された UiPath CLI
    • UiPath.CLI.Windows - Windows デバイス用に設計された UiPath CLI
  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.xWindows - レガシ

利用可能

利用可能

利用可能

2023.4.xWindows

利用可能

利用可能

利用可能

2023.4.xクロスプラットフォーム

利用可能

利用可能

利用可能

クラウド

Windows - レガシ

利用可能

利用可能

利用可能

クラウド

Windows

利用可能

利用可能

利用可能

クラウド

クロスプラットフォーム

利用可能

利用可能

利用可能

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

プロジェクトの作成に使用する UiPath Studio のバージョンは、UiPath.CLI のバージョンと一致している必要があります。たとえば、v2021.10 の UiPath Studio を使用してプロジェクトを作成する場合は、v21.10 の UiPath.CLI を使用する必要があります。

凡例: 利用可能 - 相互運用性あり、利用できません。 - 相互運用性なし

OrchestratorprojectTypeUiPath.CLI 23.10UiPath.CLI 23.6UiPath.CLI 22.10UiPath.CLI 22.4UiPath.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.xWindows - レガシ

利用できません。

利用できません。

利用できません。

利用可能

利用可能

2023.4.xWindows

利用できません。

利用できません。

利用できません。

利用できません。

利用できません。

2023.4.xクロスプラットフォーム

利用可能

利用可能

利用可能

利用可能

利用可能

クラウド

Windows - レガシ

利用できません。

利用できません。

利用できません。

利用可能

利用可能

クラウド

Windows

利用できません。

利用できません。

利用できません。

利用できません。

利用できません。

クラウド

クロスプラットフォーム

利用可能

利用可能

利用可能

利用可能

利用可能

NuGet フィードを管理する

このセクションでは、組み込みの NuGet フィードを管理する方法について説明します。 さらに、特定のプロジェクト要件に応じてカスタム NuGet フィードを使用する方法についても説明します。

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

既定では、 uipcli は以下の組み込みフィードで依存関係を検索します。 組み込みフィードを使用しない uipcli を指定するには、 --disableBuiltInNugetFeeds パラメーターを設定します。 このパラメーターは、 analyzepack、および test runの各タスクに使用できます。構成ファイルを使用して uipcli を実行する場合は、 "disableBuiltInNugetFeeds": trueに設定します。
docs image
docs image

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

オートメーションをパッケージ化する際にカスタム フィードを使用できます。

UiPath CLI でカスタム nuget.config を使用する

カスタム フィードを使用するには、次の手順に従います。

  1. 次の形式のカスタム 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>
  2. カスタム nuget.config ファイルを、 uipcli がキャッシュされているフォルダーに配置します。
    docs image

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

このページは役に立ちましたか?

サポートを受ける
RPA について学ぶ - オートメーション コース
UiPath コミュニティ フォーラム
Uipath Logo White
信頼とセキュリティ
© 2005-2024 UiPath. All rights reserved.