- 概要
- はじめに
- 概念
- UiPath CLI を使用する
- UiPath for Coding Agents
- 使用ガイド
- CI/CD レシピ
- コマンド リファレンス
- 概要
- 終了コード
- グローバル オプション
- uip codedagent
- uip docsai
- add-test-data-entity
- テスト データのキューを追加
- 追加-テスト-データ-バリエーション
- 分析
- 開発
- プロジェクトを作成
- 差分
- アクティビティを検索
- GET-ANALYZER-RULES
- get-default-activity-xaml
- エラーを取得
- 手動テスト用のテスト ケースを取得
- 手動テストステップを取得
- get-versions
- Get-workflow-example
- indicate-application
- 要素を示す
- inspect-package
- install-data-fabric-entities
- パッケージのインストールまたは更新
- list-data-fabric-entities
- list-workflow-examples
- パッケージ化
- 元に戻す
- ファイル名を実行
- 検索テンプレート
- スタートスタジオ
- 実行を停止
- UIA
- UIP トレース
- 移行
- 参照とサポート
UiPath CLI ユーザー ガイド
UiPath Flow プロジェクトの作成、パッケージ化、デバッグ、運用uip flow UiPath Flow プロジェクトです。グラフ形式のワークフローで、ノード (アクティビティ、トリガー、コネクタ) をエッジで接続して構成されています。フローは、UiPath の 2 つのオーケストレーション サーフェスの 1 つです。詳しくは、「BPMN ベースのビジネス プロセス オーケストレーション」の兄弟 uip maestro をご覧ください。
このツールは、 @uipath/flow-tool プラグイン(コマンドプレフィックス flow)として出荷されます。プラグインのインストール方法とバージョン管理方法については、「 ツール (プラグイン)」 をご覧ください。
Flow と Maestro の使い分け
| 表面 | グラフの形状 | アセット ファイル | 主なユース ケース |
|---|---|---|---|
| フロー | 視覚的なノードとエッジのグラフ | .flow (JSON) | エージェンティック ワークフロー、コネクタ オートメーション、AI ノード チェーン |
| Maestro | BPMN 2.0 ダイアグラム | .bpmn | 長期実行、人間参加型のビジネス プロセス オーケストレーション |
どちらのツールも .nupkg パッケージを Orchestrator にパブリッシュし、ランタイム プリミティブ (processes、 instance、 incident、 job、 registry) を共有します。
オーサリング フロー
Flowプロジェクトは、 project.uiproj マニフェストと1つ以上の .flow ファイル(およびパック時に生成されるサポートファイル)を含むディレクトリです。
# 1. Scaffold a new project
uip flow init invoice-flow
# 2. Discover nodes in the registry
uip flow registry pull
uip flow registry search slack
# 3. Edit the .flow file — add nodes, edges, variables, bindings
uip flow node add invoice-flow/invoice-flow.flow uipath.connector.slack.send-message --label "Notify"
uip flow edge add invoice-flow/invoice-flow.flow start node_a1b2c3d4
uip flow node configure invoice-flow/invoice-flow.flow node_a1b2c3d4 --detail '{"connectionId":"…","folderKey":"…","method":"POST","endpoint":"/…"}'
# 4. Validate structure (and optionally governance policy)
uip flow validate invoice-flow/invoice-flow.flow
# 5. Run against Studio Web to smoke-test
uip flow debug ./invoice-flow
# 6. Pack for deployment
uip flow pack ./invoice-flow ./dist --version 1.0.0
# 1. Scaffold a new project
uip flow init invoice-flow
# 2. Discover nodes in the registry
uip flow registry pull
uip flow registry search slack
# 3. Edit the .flow file — add nodes, edges, variables, bindings
uip flow node add invoice-flow/invoice-flow.flow uipath.connector.slack.send-message --label "Notify"
uip flow edge add invoice-flow/invoice-flow.flow start node_a1b2c3d4
uip flow node configure invoice-flow/invoice-flow.flow node_a1b2c3d4 --detail '{"connectionId":"…","folderKey":"…","method":"POST","endpoint":"/…"}'
# 4. Validate structure (and optionally governance policy)
uip flow validate invoice-flow/invoice-flow.flow
# 5. Run against Studio Web to smoke-test
uip flow debug ./invoice-flow
# 6. Pack for deployment
uip flow pack ./invoice-flow ./dist --version 1.0.0
オーサリングコマンド
| コマンド | 目的 |
|---|---|
uip flow init | 新しい Flow プロジェクトを素早く作成する |
uip flow node | .flow ファイル内のノードを追加、設定、一覧表示、削除する |
uip flow edge | ノード間のエッジを追加、一覧表示、削除します |
uip flow validate | スキーマ (およびガバナンス ポリシー) に照らして .flow ファイルを検証します |
uip flow debug | プロジェクトを Studio Web にアップロードし、デバッグ セッションを実行します |
uip flow pack | デプロイ可能な .nupkg |
uip flow registry | 使用可能なノードの種類を参照して検索する (OOTB + コネクタ) |
変数、バインド、およびレイアウト ヘルパー
これらのCLIサーフェスはまだサイドバーにはありませんが、現在呼び出すことができます—それらはプログラムで .flow JSONを編集するための薄いラッパーです。
uip flow variable— 最上位のワークフロー変数 (in、out、inoutを追加/一覧表示/削除します。node-edge.md をご覧ください。uip flow variable-update— 完了時に実行されるノード(=js:ctx.output)にJS代入式をアタッチします。uip flow binding— 公開時に解決されるリソースのバインド (プロセス、エージェント、接続など) を追加/一覧表示/削除します。uip flow tidy— 自動レイアウト: オーバーラップを除去するためにノードを再配置します。
実行時
実行時に、パブリッシュされたフロー パッケージは Orchestrator 上の プロセス になります。1 つ起動する とインスタンスが作成されます。各実行試行は ジョブです。失敗 はインシデントとして表面化します。
| コマンド | 目的 |
|---|---|
uip flow process | デプロイ済みのフロー プロセスの一覧を表示して実行する Flow プロセス (list、 get、 run) |
uip flow processes | 複数のフォルダーにわたるプロセスの概要、およびプロセスごとのインシデント |
uip flow instances | 実行中のインスタンス (list、 get、 pause、 resume、 cancel、 retry、 migrate、 goto、 variables、...) を検査およびステアリングします。 |
uip flow incidents | インシデントの概要と詳細を読む |
uip flow job | トレース (traces) をストリームし、ジョブのステータスを検査する |
Orchestrator 内のジョブとプロセスは、Orchestrator ツールを使用して操作されます。詳しくは、「 Orchestrator のジョブ と Orchestrator のプロセス」をご覧ください。
命名規則
- すべての
uip flowサブコマンドは、 グローバルオプション (--output、--output-filter、--log-level、--log-file) を尊重します。 - 既定の出力は JSON です。
- 終了コードは 標準コントラクトに従います。
- ほとんどのランタイム コマンドでは、最初に
uip loginが必要です — 「認証」をご覧ください。
参照
uip maestro— BPMN のビジネス プロセス オーケストレーションの兄弟- ツール (プラグイン)
- 認証
- グローバル オプション、 終了コード