- 概要
- はじめに
- 概念
- 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 ユーザー ガイド
uip agent push と uip agent pull は、Studio Web の往復の 2 つの部分にあたります。これらは、同じ転送形式 (エージェント プロジェクトの ZIP アーカイブである.uis)、同じ認証モデル、同じエラー サーフェスを共有します。push を使用してローカル プロジェクトを Studio Web に送信し、Agent Builder の UI に表示されるようにします。pull を使用して、Studio Web からソリューションを.uisとしてダウンロードし、検査、抽出、または Orchestrator のデプロイにパックすることができます。
どちらの動詞にも、アクティブなCLIセッション(uip login)が必要です。
すべてのサブコマンドは、 グローバルオプション (--output、 --output-filter、 --log-level、 --log-file) を優先します。終了コードは 標準コントラクトに従います。
UIP エージェントのプッシュ
エージェント プロジェクトを新しいソリューションとして Studio Web にインポートするか、既存のソリューションを上書きします。
入力がディレクトリの場合、push はプロジェクト構造を検証し、Studio Web のスキーマ検証パスを実行し (--skip-schema-validation場合を除く)、.agent-builder/を除く一時的な.uisにパックして、アーカイブを Studio Web Solution Import API に投稿します。入力がすでに .uisの場合、アーカイブはそのままアップロードされます。
ディレクトリ プッシュが成功すると、プロジェクト ルートの SolutionStorage.json ID が、返されたクラウド ソリューションとプロジェクト ID で更新されます。後続の uip agent eval run 呼び出しでは、 --solution-idを渡すことなくこれらの ID を使用できます。
概要
uip agent push [path] [-n <name>] [--overwrite <solutionId>] [--skip-schema-validation] [--login-validity <minutes>]
uip agent push [path] [-n <name>] [--overwrite <solutionId>] [--skip-schema-validation] [--login-validity <minutes>]
引数
[path](オプション、デフォルト.) — エージェント プロジェクト ディレクトリ または.uisファイルへのパスです。
オプション
| フラグ | 既定 (Default) | 目的 |
|---|---|---|
-n, --name <name> | エージェント metadata.name → パスのベース名 | Studio Web のソリューション名。 |
--overwrite <solutionId> | — | 既存のソリューションを新しいソリューションを作成する代わりに ID で上書きします。エンドポイントを POST /api/Solution/Import から POST /api/Solution/<id>/Overwriteに変更します。 |
--skip-schema-validation | 無効 | Studio Web のスキーマの検証パスをスキップします。ディレクトリ入力のみ — .uis 入力では、スキーマの検証は実行されません。 |
--login-validity <minutes> | 10 | トークンの有効期間は、最小時間 (分) です。 |
例
# Push the current directory as a new solution
uip agent push
# Push a specific directory
uip agent push ./my-agent
# Overwrite an existing solution in place
uip agent push ./my-agent --overwrite a1b2c3d4-0000-0000-0000-000000000001
# Push a pre-packed archive
uip agent push ./dist/my-agent.uis
# Push the current directory as a new solution
uip agent push
# Push a specific directory
uip agent push ./my-agent
# Overwrite an existing solution in place
uip agent push ./my-agent --overwrite a1b2c3d4-0000-0000-0000-000000000001
# Push a pre-packed archive
uip agent push ./dist/my-agent.uis
データシェイプ(--output json)
{
"Code": "AgentPush",
"Data": {
"Status": "Agent imported into Studio Web",
"Name": "my-agent",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"ProjectCount": 1,
"CloudProjectId": "a1b2c3d4-0000-0000-0000-000000000002"
}
}
{
"Code": "AgentPush",
"Data": {
"Status": "Agent imported into Studio Web",
"Name": "my-agent",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"ProjectCount": 1,
"CloudProjectId": "a1b2c3d4-0000-0000-0000-000000000002"
}
}
--overwriteでは、Status が"Solution overwritten successfully"され、渡された値がSolutionIdエコーされます。応答に projects 配列が含まれていない場合は"-"CloudProjectId。
UIP エージェント プル
Studio Web からソリューションを .uis アーカイブとしてダウンロードします。必要に応じて、アーカイブを兄弟ディレクトリに抽出します。
概要
uip agent pull <solutionId> [-d <dir>] [-n <name>] [--extract] [--login-validity <minutes>]
uip agent pull <solutionId> [-d <dir>] [-n <name>] [--extract] [--login-validity <minutes>]
引数
<solutionId>(必須) — ソリューション UUID。uip agent listから取得します。
オプション
| フラグ | 既定 (Default) | 目的 |
|---|---|---|
-d, --destination <dir> | . | ダウンロードされるファイルの保存先ディレクトリです。必要に応じて作成します。 |
-n, --name <name> | <solutionId> | 出力ファイル名(拡張子なし)。.uis 存在しない場合は追加されます。 |
--extract | 無効 | ダウンロード後、 .uis と一緒に同じ名前のディレクトリに抽出します。 |
--login-validity <minutes> | 10 | トークンの有効期間は、最小時間 (分) です。 |
例
# Download by ID into the current directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001
# Download into a specific directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 -d ./downloads
# Download with a friendly filename and extract
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 \
-d ./downloads \
-n invoice-agent \
--extract
# Download by ID into the current directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001
# Download into a specific directory
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 -d ./downloads
# Download with a friendly filename and extract
uip agent pull a1b2c3d4-0000-0000-0000-000000000001 \
-d ./downloads \
-n invoice-agent \
--extract
データシェイプ(--output json)
{
"Code": "AgentPull",
"Data": {
"Status": "Solution exported successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"Output": "/abs/path/downloads/a1b2c3d4-0000-0000-0000-000000000001.uis"
}
}
{
"Code": "AgentPull",
"Data": {
"Status": "Solution exported successfully",
"SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
"Output": "/abs/path/downloads/a1b2c3d4-0000-0000-0000-000000000001.uis"
}
}
--extractでは、ペイロードにはさらに ExtractedTo: "/abs/path/downloads/<name>"が含まれます。
往復の例
# Iterate locally, push to Studio Web, edit in the UI, pull back
uip agent init ./my-agent
uip agent validate ./my-agent
uip agent push ./my-agent # captures SolutionId
# (edit in Studio Web)
uip agent pull <SolutionId> -d ./downloads --extract
# compare ./my-agent with ./downloads/<SolutionId>/ to reconcile
# Iterate locally, push to Studio Web, edit in the UI, pull back
uip agent init ./my-agent
uip agent validate ./my-agent
uip agent push ./my-agent # captures SolutionId
# (edit in Studio Web)
uip agent pull <SolutionId> -d ./downloads --extract
# compare ./my-agent with ./downloads/<SolutionId>/ to reconcile
関連
uip agent list—pullにフィードするソリューション ID を列挙します。uip agent pack— Studio Web を介さずに.uisを作成します。uip agent validate— サーバー側の拒否を回避するため、push前に実行してください。uip agent share— プッシュ後にソリューションを共有します。
参照
- 認証 — セッションと
--login-validity。 - 概念: スキル — インポートしたソリューションのエントリ ポイントがスキルになる仕組み。
- グローバル オプション、 終了コード。