最初のコマンド (クイックスタート)

このクイックスタートでは、新規インストールから Orchestrator でのジョブの実行までの 5 つのコマンドについて説明します。5 分間待ちます。

はじめる前に

• UiPath CLI をインストールします。「 UiPath CLI をインストールする」をご覧ください。
• 少なくとも 1 つのテナントへのアクセス権を持つ UiPath Automation Cloud または Automation Suite のアカウントを持っている。
• プロセスを 1 つ以上含む Orchestrator 内のフォルダーの名前 (またはパス) がわかっている。既定のフォルダー Shared 、ほとんどの無料トライアルで使用できます。

ターミナルを開きます。以下のコマンドはすべてそこに入力されます。

ステップ1.サインイン

対話型ログインを開始します。

uip login

uip 、既定のブラウザーを開いて UiPath へのサインインを求め、認証後にテナントを選択するよう求められます。ブラウザタブが成功を報告したら、ターミナルに戻ります—セッションはアクティブです。セッションは ~/.uipath/ (現在のフォルダーまたは親フォルダーにプロジェクトローカルの .uipath/ フォルダーが存在する場合は、そのフォルダー内) で保持されます。

ヒント:

テナントが既にわかっている場合にピッカーをスキップする場合は、 uip login --tenant DefaultTenantを実行します。CI 環境の場合は、非対話型フローの 認証 を参照してください。

ステップ2.セッションを確定します

uip login status --output table

期待される出力:

Status         Organization   Tenant          Expiration Date
Logged in      my-org         DefaultTenant   2026-04-24T18:42:00Z

注:

すべての uip コマンドは 既定で JSON を出力します。読みやすいビューの --output table を渡します。4つの出力フォーマット(table、json、yaml、plain)とJMESPath--output-filterフラグのグローバルオプションを参照してください。

コマンドで Not logged inが報告された場合は、 uip loginを再実行します。

ステップ3.フォルダーのリストを取得

最初の実際のクエリが Orchestrator にヒットします。

uip or folders list

これにより、テナントの最初の 50 個のフォルダーが返されます。出力には、各フォルダーの Key (GUID)、 Name、 Path、および Typeが含まれます。

フィルター処理したり、より深く調べたりするには、 --all を渡してフィルターのロックを解除します。

uip or folders list --all --name Shared
uip or folders list --all --top-level

注:

フィルター フラグ (--name、 --path、 --type、 --top-level、 --order-by) が効果を持つ前に、この--allが必要です。これは意図的なセーフティネットであり、大規模なテナントのフィルターのタイプミスは、フィルタリングされていない最初のページをサイレントに返します。

ステップ4.実行するプロセスを検索する

手順 3 からフォルダー (ここでは例として Shared を使用しています) を選択し、そのプロセスを一覧表示します。

uip or processes list --folder-path Shared

出力には、各プロセスの Key (GUID)、 Name、 Version、および [ Type] が表示されます。実行するプロセスの Key をコピーします。次の手順の <process-key> をその GUID に置き換えます。

ステップ5.ジョブを開始する

uip or jobs start <process-key>

uip は、Orchestrator が要求を受け入れた直後に返されます。応答には、新しいジョブの Key、 State (通常は最初は Pending )、および解決済みの ProcessNameが表示されます。

ジョブが完了して出力が表示されるまでブロックするには、 --wait-for-completionを追加します。

uip or jobs start <process-key> --wait-for-completion --timeout 600

--wait-for-completionを使用すると、コマンドは 5 秒ごとにポーリングし (既定)、ジョブが終了状態 (Successful、Faulted、Stopped) に達すると終了します。終了コードは、 Faultedで 0 以外です。--timeout 秒単位で、既定値は 300 です。

入力引数を --input-arguments (JSON 文字列) または --input-file (JSON ファイルへのパス) で渡します。

uip or jobs start <process-key> \
  --input-arguments '{"invoiceNumber":"INV-001","customer":"Contoso"}'

あなたが今やったこと

5 つのコマンドで、2 つの Orchestrator リソースを認証し、クエリを実行して、ジョブを開始しました。すべての uip コマンドは、複数のリソースを持つツールの場合は uip <tool> <resource> <verb> 、単一ワークフロー ツールの場合は uip <tool> <verb> という同じ形状に従い、出力形式、フィルター処理、およびログに対して同じグローバル フラグをサポートします。詳しくは、「グローバル オプション」をご覧ください。

次のステップ

• 最初のパイプライン — ソリューションをローカルにパッケージ化し、テナントにパブリッシュして、Orchestrator にデプロイします。
• 認証 — インタラクティブなログインの詳細、CI の外部アプリケーションクライアント資格情報、コンテナの環境変数フロー。
• 出力形式 — table、 json、 yaml、および plainを切り替え、 --output-filterで JMESPath フィルター処理を使用します。
• Orchestrator コマンド リファレンス — すべてのコマンド、すべてのフラグ。
• コーディング エージェントで UiPath CLI を使用する — Claude Code、Cursor、GitHub Copilot などのエージェントで UiPath のオートメーションを構築 uip。