- 概要
- はじめに
- 概念
- 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: npm install -g の後にコマンドが見つからない
npm グローバルプレフィックスが PATHにありません。見つけてください。
npm config get prefix
npm config get prefix
macOS / Linuxでは、返されたプレフィックス+ /bin をシェルプロファイルに追加します(~/.zshrc、 ~/.bashrc)。Windowsでは、 %APPDATA%\npm デフォルトで PATH になっているはずです—新しい端末を開いてアップデートを取得します。
詳しくは、「 UiPath CLI をインストールする — トラブルシューティング」をご覧ください。
EACCES: インストール中に権限が拒否されました
システム所有のnpmプレフィックスに書き込もうとしています。sudoは使用しないでください。代わりに、ユーザーローカルのプレフィックスを設定します。
mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
export PATH="$HOME/.npm-global/bin:$PATH"
npm install -g @uipath/cli
mkdir -p ~/.npm-global
npm config set prefix ~/.npm-global
export PATH="$HOME/.npm-global/bin:$PATH"
npm install -g @uipath/cli
認証
すべてのコマンドで AuthenticationError (終了コード 2) が発生する
有効なセッションがありません。いずれも:
uip loginを実行して対話型セッションを開始する- CI で外部アプリケーションの資格情報を渡します。
uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"、または - トークンが事前発行されているコンテナーの場合:
UIPATH_CLI_ENABLE_ENV_AUTH=true変数にUIPATH_CLI_AUTH_TOKEN/UIPATH_CLI_ORGANIZATION_*/UIPATH_CLI_TENANT_*を加えた値を設定します。
チェックのステータス: uip login status
「 認証」をご覧ください。
トークンの期限切れまたはuipログインステータスの期限切れ
更新トークンは有効でなくなります。通常は、何週間も操作されなかったか、管理者が強制的にサインアウトした後です。uip loginを再実行します。
env-var 認証の場合、トークンは uipに対して不透明です。発行側から UIPATH_CLI_AUTH_TOKEN を回転させます。
uip login 後にテナントが選択されない
テナントを選択せずにログインが完了しました。ピッカーがキャンセルされたか、 --tenant 渡されたが値がアクセス可能なテナントと一致しませんでした。uip login --interactiveでリトライし、リストから選択するか、uip login --tenant <exact-name>します。
UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET環境変数は無視されているようです
彼らはそうです。UiPath CLI では、これらの値に対する暗黙的な env-var の読み取りが削除されました。明示的に渡す:
uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
uip login --client-id env.UIPATH_CLIENT_ID --client-secret env.UIPATH_CLIENT_SECRET --tenant "$UIPATH_TENANT"
プレフィックス env. は、実行時に環境から解決するよう uip に指示します。コマンド ラインでは値を公開しません。
ツール
ツール '' がインストールされていません — 自動インストールを実行しようとしています
情報提供 — ホストは初回使用時にツールをダウンロードしています。それ以降の呼び出しでは、インストール済みコピーが再利用されます。CIでこのログメッセージを回避するには、プリインストールします。
uip tools install @uipath/orchestrator-tool @uipath/solution-tool
uip tools install @uipath/orchestrator-tool @uipath/solution-tool
ツールの自動インストールの制御を参照してください。
'' の自動インストールに失敗しました
ツールのダウンロードに失敗しました。一般的な原因:
- ネットワークなし — 接続またはプロキシ設定を確認します。
- 企業プロキシはnpmをブロック します—
HTTPS_PROXY=http://proxy.example.com:8080を設定します。 - npm レジストリが解決できない — 到達可能な場所
npm config get registryポイントを確認します。
手動でリトライする: uip tools install <verb>
アップグレード後にツール コマンドが uip --help から消える
ツールのバージョンがホストと歩調を合わせていません。修正:
uip tools update
uip tools update
これにより、インストールされたすべてのツールがホストのMAJOR内の最新バージョンになります。マイナーライン。「バージョン管理と安定性」をご覧ください。
ValidationError: package '' is not on the whitelist
@uipath/されていないツールをインストールしようとしました。1.x はホワイトリストに登録されたセットのみをサポートします。他社製のツールはまだ利用できません。
出力とフィルター処理
ValidationError: invalid --output-filter (exit 3)
JMESPath 式を解析できませんでした。CLI は、コマンドを実行する前に解析時に検証します — フィルタを修正して再試行してください。JMESPath 参照: jmespath.org.
よくある落とし穴: --output-filter "Data.Jobs[0].Key" は機能しますが、 --output-filter "Data.Jobs[-1].Key" は機能しません — JMESPath [-1] はサポートされていません。代わりに Data.Jobs | [-1:][0].Key を使用するか、 jqを使用して後処理します。
テーブルを期待していましたが、JSONを取得しました
既定の出力は JSON です。読みやすいビューの --output table を渡します。詳しくは、「出力形式」をご覧ください。
パイプライン ステップで JSON の解析に失敗する — JSON 以外のテキストが stdout に表示される
ログ、進行状況バー、および一部のエラー メッセージは、stdout ではなく stderr に送られます。JSON 以外のものが stdout にある場合は、両方のストリームが同じファイルにリダイレクトされている可能性があります。それらを個別にリダイレクトします。
uip or folders list > folders.json 2> uip.log
uip or folders list > folders.json 2> uip.log
コマンドと終了コード
コマンドは0で終了しますが、失敗することを期待していました
Success Resultは、ペイロードが空の場合でも終了コード 0 にマップされます。たとえば、uip or folders list --all --name Nonexistent は Data: []で0を終了します。ペイロード形状の分岐:
COUNT=$(uip or folders list --all --name Foo --output-filter "length(Data)" --output plain)
[[ "$COUNT" -eq 0 ]] && { echo "no match"; exit 1; }
COUNT=$(uip or folders list --all --name Foo --output-filter "length(Data)" --output plain)
[[ "$COUNT" -eq 0 ]] && { echo "no match"; exit 1; }
uip tm wait exits with 2 — 認証は失敗しましたか?
いいえ。 tm wait は、終了コード 2 を認証ではなく タイムアウトに再利用します。あいまいさを解消するには、エンベロープ内の Result を確認します (AuthenticationError と TimeoutError)。このドメイン固有の再利用は、「 終了コード」に一覧表示されます。
uip tm テストセットの実行は成功しましたが、テストは失敗します
設計上正しい。tm testsets run は、Orchestrator が実行を受け入れる 0 終了します。判定は後で行われます。3段階のイディオムを連鎖させます。
EXEC_ID=$(uip tm testsets run --test-set-key "$TESTSET" --output-filter "Data.ExecutionId" --output plain)
uip tm wait --execution-id "$EXEC_ID" --timeout 1800
FAILED=$(uip tm report get --execution-id "$EXEC_ID" --output-filter "Data.Failed" --output plain)
[[ "$FAILED" -gt 0 ]] && { echo "$FAILED tests failed"; exit 1; }
EXEC_ID=$(uip tm testsets run --test-set-key "$TESTSET" --output-filter "Data.ExecutionId" --output plain)
uip tm wait --execution-id "$EXEC_ID" --timeout 1800
FAILED=$(uip tm report get --execution-id "$EXEC_ID" --output-filter "Data.Failed" --output plain)
[[ "$FAILED" -gt 0 ]] && { echo "$FAILED tests failed"; exit 1; }
「 スクリプティング パターン」、「 uip tm テストセット」、および 「uip tm 実行」をご覧ください。
構成
環境変数の変更は反映されません
長期実行プロセス (エージェント、監視対象のスクリプト) は、起動時に 1 回、環境を読み取ります。環境変数を変更した後、プロセスを再起動してください。ワンショット コマンドの場合、新しい uip 呼び出しは常に現在の環境を読み取ります。
優先順位を確認します: CLI フラグ>環境変数>組み込みデフォルトです。「設定」をご覧ください。
シェル補完
タブ補完が完了しない
uip completion後に新しいターミナルを開いて、シェルの rc ファイルが再ソースされるようにします。それでも見つからない場合は、 uip completion --print を実行して、 uip がインストールされていると思われるブロックを確認します。 ~/.zshrc / ~/.bashrc / $PROFILEと比較してください。
uip or packages upload --package-name は名前を提案しません
フラグ値の動的補完は zsh のみであり、PATHでjqする必要があります。jq をインストールするか、zsh に切り替えます。static サブコマンド + オプション名補完は、関係なく 4 つのシェルすべてで機能します。
シェルと CI の統合
CI の手順が uip ログイン時または uip スキルのインストール時にハングする
コマンドは対話型プロンプトを待機しています。必要なフラグを渡します。
uip login --tenant <name>(テナント ピッカーをスキップ)uip skills install --agent <name>(エージェント ピッカーをスキップ)
どのプロンプトが対話型かわからない場合は、非 TTY コンテキストでローカル uip --log-level debug … (リダイレクト stdout) で失敗したコマンドを実行し、表示されたプロンプトを調べます。
uipまたはjobsはすぐに戻ります—私はそれを待ってほしかったです
既定では、 jobs start は実行を受け入れて終了します。--wait-for-completion追加:
uip or jobs start <process-key> --wait-for-completion --timeout 600
uip or jobs start <process-key> --wait-for-completion --timeout 600
ここでは見つけられなかったもの
実行しているコマンドのリファレンス ページを確認してください — それぞれに独自の終了コードと例のセクションがあります。次に、リリースノートで同様の症状を検索します。一致するものがない場合は、収集します。
uip --versionuip tools list- 正確なコマンドと完全な stderr / stdout
- JSON エンベロープの
Resultフィールド
…UiPath CLI チームに問題を提起します。
参照
- 終了コード —
tm wait特殊なケースを含む、各コードの意味。 - スクリプト パターン — リトライ、ポーリング、ストリームの分離、べき等パイプライン。
- 認証 — 3 つの認証フローの詳細。
- UiPath CLI をインストールする — トラブルシューティング — インストール固有のエラー。
- インストール
- uip: npm install -g の後にコマンドが見つからない
- EACCES: インストール中に権限が拒否されました
- 認証
- すべてのコマンドで AuthenticationError (終了コード 2) が発生する
- トークンの期限切れまたはuipログインステータスの期限切れ
- uip login 後にテナントが選択されない
- UIPATH_CLIENT_ID / UIPATH_CLIENT_SECRET環境変数は無視されているようです
- ツール
- ツール '
' がインストールされていません — 自動インストールを実行しようとしています - '
' の自動インストールに失敗しました - アップグレード後にツール コマンドが uip --help から消える
- ValidationError: package '
' is not on the whitelist - 出力とフィルター処理
- ValidationError: invalid --output-filter (exit 3)
- テーブルを期待していましたが、JSONを取得しました
- パイプライン ステップで JSON の解析に失敗する — JSON 以外のテキストが stdout に表示される
- コマンドと終了コード
- コマンドは0で終了しますが、失敗することを期待していました
- uip tm wait exits with 2 — 認証は失敗しましたか?
- uip tm テストセットの実行は成功しましたが、テストは失敗します
- 構成
- 環境変数の変更は反映されません
- シェル補完
- タブ補完が完了しない
- uip or packages upload --package-name
は名前を提案しません - シェルと CI の統合
- CI の手順が uip ログイン時または uip スキルのインストール時にハングする
- uipまたはjobsはすぐに戻ります—私はそれを待ってほしかったです
- ここでは見つけられなかったもの
- 参照