UiPath Documentation
uipath-cli
latest
false
UiPath CLI ユーザー ガイド
重要 :
このコンテンツは機械翻訳によって処理されています。 新しいコンテンツの翻訳は、およそ 1 ~ 2 週間で公開されます。

uip 関数

「uip 関数」の構文とオプション - UiPath JS/TS 関数と Python 関数を構築、提供、実行、パブリッシュします。

uip function は、 UiPath Functions — UiPath プラットフォーム上でパッケージ化および実行される小型の JS/TS または Python ハンドラーを構築、提供、パブリッシュします。uip function は正規のグループ名です。 uip functions (複数形) はエイリアスとして受け入れられます。

概念​

  • これは言語ディスパッチャーであり、ネイティブ ツールではありません。setupを除くすべての動詞はシンフォワーダーです: CLI はプロジェクトの言語 (現在のディレクトリの uipath.json、package.json、または pyproject.toml、または newの --language/-l から) を検出し、生の引数をインプロセスの JS/TS CLI (@uipath/coded-functions-js-cli) または生成された Python CLI にルーティングします。ラッパーが宣言していないフラグは、基礎となる CLI に変更されずに転送されます。
  • 言語の解決は、 init と newにとって重要です。init は Python 専用 です。JS/TS の場合は、代わりに new --emptyでスキャフォールディングします。new 自動検出します。検出結果が決定的でない場合は、 --language js|ts|py/pythonを渡さない限り、既定で TypeScript が使用され、ログに記録された警告が表示されます。
  • setup ツールチェーンを検証します。JS/TS プロジェクトの場合は Node.js ≥20、Python プロジェクトの場合は uipath パッケージを使用した Python をチェックします。また、Node.jsチェックは、 new が JS/TS CLI に転送される前に自動的に実行されます。Python 関数のコマンドは、Python を設定するまで、uip function setup を指すConfigErrorで失敗します。
  • ターゲットpublishと push の異なるターゲット: publish は、パックされた.nupkgを Orchestrator フィードにアップロードします。push プロジェクトを Studio Web プロジェクトに直接同期します。どちらも --url/--org/--token (または一致する UIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKEN 環境変数) を受け入れます。
  • ソリューションの自動登録。成功した Python init は、プロジェクトが存在する場合、そのプロジェクトを親 .uipx ソリューションに自動登録します ( agent/case/flow init と同じパターン) — オプトアウトするには --skip-solution-registration 渡します。これは、基礎となる Python CLI 独自の init 出力の後に別の FunctionsInitSolutionRegistration 成功エンベロープを介して報告します。

概要​

uip function setup [--force]
uip function new [name] [--name <name>] [-l, --language ts|js|py] [--empty]
uip function init [--language py] [--skip-solution-registration]
uip function serve [--port <port>] [--runtime node|deno]
uip function run [name] [--input <json>] [--input-file <path>]
uip function pack
uip function push [--url <url>] [--project-id <id>] [--org <org>] [--token <token>]
uip function publish [--url <url>] [--org <org>] [--token <token>] [--feed-id <id>]
uip function runtime-install [--path <folder>]
uip function setup [--force]
uip function new [name] [--name <name>] [-l, --language ts|js|py] [--empty]
uip function init [--language py] [--skip-solution-registration]
uip function serve [--port <port>] [--runtime node|deno]
uip function run [name] [--input <json>] [--input-file <path>]
uip function pack
uip function push [--url <url>] [--project-id <id>] [--org <org>] [--token <token>]
uip function publish [--url <url>] [--org <org>] [--token <token>] [--feed-id <id>]
uip function runtime-install [--path <folder>]

UIP 関数の設定​

Functions プロジェクトに必要なツールチェーンを確認します。JS/TS の場合は Node.js v20 以降、Python の場合は Python の場合は uipath パッケージを使用します。Node.jsが見つからないか古い場合、コマンドは失敗し、「」という ConfigErrorが表示されます。Python の設定が見つからないことが報告されますが、コマンドは失敗しないため、JS/TS のみのマシンはブロックされません。結果はキャッシュされ、uip codedagent setupと共有されるため、どちらのコマンドでも両方に対して Python が構成されます。

オプション​

長押し値 (Value)説明
--forceフラグキャッシュされた結果が存在する場合でも、検証を再実行してください。既定値は falseです。
uip function setup --force
uip function setup --force

uip 関数 new​

既定で hello-world 関数を含む新しい Functions プロジェクトをスキャフォールディングします。

引数​

名前Required目的
[name]×プロジェクト名/ディレクトリ。既定 my-functionsです。--nameとして渡すこともあります。

オプション​

長押し値 (Value)説明
--name <name>string位置引数の代替手段。
-l, --language <lang>ts (既定) | js | py/pythonプロジェクトの言語。
--emptyフラグhello-world 関数 — 空のプロジェクトをスキップします。JS/TS のみ。
uip function new my-fn --language ts
uip function new my-fn --language py
uip function new my-fn --language ts
uip function new my-fn --language py

データシェイプ(--output json)​

{ "Code": "NewComplete", "Data": { "Message": "Project created at ./my-fn" } }
{ "Code": "NewComplete", "Data": { "Message": "Project created at ./my-fn" } }

uip 関数 init​

Python のみ: エントリ ポイントを検出し、 entry-points.json/bindings.json/project.uiprojを (再) 生成します。Python プロジェクトの場合は、 pack/push の前に実行する必要があります。JS/TS の場合は、代わりに new --empty を使用してください。 init は、JS/TS プロジェクトまたは検出されない言語に対して明示的な「Python のみ」エラーが発生して失敗します。

オプション​

長押し値 (Value)説明
--language pyフラグ/値検出があいまいな場合は Python の言語を強制的に解決します。
--skip-solution-registrationフラグ親 .uipx ソリューションにプロジェクトを自動登録しないでください。
uip function init
uip function init

データシェイプ(--output json)​

{ "Code": "InitComplete", "Data": { "Message": "Project initialized." } }
{ "Code": "InitComplete", "Data": { "Message": "Project initialized." } }

続いて、2回目の成功エンベロープレポートソリューションの登録を行います。

{
  "Code": "FunctionsInitSolutionRegistration",
  "Data": { "SolutionRegistration": { "Status": "Registered", "...": "..." } }
}
{
  "Code": "FunctionsInitSolutionRegistration",
  "Data": { "SolutionRegistration": { "Status": "Registered", "...": "..." } }
}

SolutionRegistration.Statusは、親ソリューションが存在しない場合、または--skip-solution-registrationが渡されたときに"OptedOut""NotInSolution"されます。常に存在し、省略されることはありません。

uip 関数 serve​

ホット・リロードでローカル・ファンクション・サーバーを起動します。JS/TS のみ。

オプション​

長押し値 (Value)説明
--port <port>integerリッスンするポート。既定 7070です。
--runtime <runtime>node (既定) | deno提供するランタイム。
uip function serve
uip function serve

データシェイプ(--output json)​

{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }
{ "Code": "ServeStarted", "Data": { "Message": "Listening on http://localhost:7070" } }

UIP 関数の run​

1 つの関数を 1 回実行し、その結果を出力します。関数名は、プロジェクトの関数リストから取得されています。

引数​

名前Required目的
[name]×実行する関数の名前です。

オプション​

長押し値 (Value)説明
--input <json>JSON入力ペイロード。既定 {}です。
--input-file <path>パスJSON 入力ファイルへのパスです。JS/TS プロジェクトでは、 よりも優先 --input。
# Python project: run the 'hello' function once with a JSON payload and read the result as JSON
uip function run hello --input '{"name":"Ada"}' --output json

# Python project: run a function with a payload kept in a file
uip function run hello --input-file ./payload.json --output json
# Python project: run the 'hello' function once with a JSON payload and read the result as JSON
uip function run hello --input '{"name":"Ada"}' --output json

# Python project: run a function with a payload kept in a file
uip function run hello --input-file ./payload.json --output json

データシェイプ(--output json)​

{ "Code": "RunComplete", "Data": { "message": "Hello, Ada!" } }
{ "Code": "RunComplete", "Data": { "message": "Hello, Ada!" } }

構造化された結果は、明示的に渡すと Python プロジェクトに適用されます --output json または明示的に --output yaml 。

  • Data は関数独自の出力であり、そのフィールド名は関数が宣言したとおりに保持されます。
  • 関数がスカラー、配列、または何も返さない場合、値は単一の Output キーの下に配置されます。
  • 進行状況と実行自体のログは stderr に送られるため、stdout はエンベロープのみを運びます。
  • 実行に失敗すると、ErrorCode: "unknown_error" と実行の終了コード (Message) とともにResult: "Failure"が返されます。実行自体のエラーはstderrにあります。

明示的な --output json/yamlがない場合、または table または plainがある場合、 run は基になる CLI 独自の出力を出力します。JS/TS プロジェクトでは、 --output は runではサポートされていません。CLI は通知を出力し、関数自体の出力は変更されません。

UIP ファンクション パック​

デプロイ用にプロジェクトを .nupkg にパックします。プロジェクトのロック ファイルは常にパッケージに含まれています。

uip function pack
uip function pack

データシェイプ(--output json)​

{ "Code": "PackComplete", "Data": { "Message": "Package created: my-fn.0.0.1.nupkg" } }
{ "Code": "PackComplete", "Data": { "Message": "Package created: my-fn.0.0.1.nupkg" } }

uip 関数 push​

プロジェクトを Studio Web に同期します — エントリ ポイントを生成し、変更されたファイルをアップロードします。

オプション​

長押し値 (Value)Required説明
--url <url>url×UiPath プラットフォームの URL です。UIPATH_URLにフォールバックします。
--project-id <id>GUID条件付きStudio Web プロジェクト ID です。必須ですが、フラグの代わりに UIPATH_PROJECT_ID から取得される場合があります。
--org <org>string×組織名。UIPATH_ORGANIZATION_NAMEにフォールバックします。
--token <token>string×アクセス トークン。UIPATH_ACCESS_TOKENにフォールバックします。
uip function push --project-id 1f2a3b4c-0000-0000-0000-000000000001
uip function push --project-id 1f2a3b4c-0000-0000-0000-000000000001

データシェイプ(--output json)​

{ "Code": "PushComplete", "Data": { "Message": "Push complete." } }
{ "Code": "PushComplete", "Data": { "Message": "Push complete." } }

uip 関数: publish​

最新の .nupkg を Orchestrator フォルダーにアップロードします。--feed-idを使用しない場合、フィードの入力を対話的に求めます (キャンセルするには ESC で入力します)。CI が使用できるように --feed-id渡してピッカーをスキップします。

オプション​

長押し値 (Value)説明
--url <url>urlUiPath プラットフォームの URL です。UIPATH_URLにフォールバックします。
--org <org>string組織名。UIPATH_ORGANIZATION_NAMEにフォールバックします。
--token <token>stringアクセス トークン。UIPATH_ACCESS_TOKENにフォールバックします。
--feed-id <id>GUIDパブリッシュ先のフィード — 対話型ピッカーをスキップします。
# Interactive feed picker
uip function publish

# CI use — skip the picker
uip function publish --feed-id 9b2c1d4e-0000-0000-0000-000000000001
# Interactive feed picker
uip function publish

# CI use — skip the picker
uip function publish --feed-id 9b2c1d4e-0000-0000-0000-000000000001

データシェイプ(--output json)​

{ "Code": "PublishComplete", "Data": { "Message": "Package published." } }
{ "Code": "PublishComplete", "Data": { "Message": "Package published." } }

uip 関数 runtime-install​

独自の package.json を持つランナー フォルダーを作成し、そこにランタイム依存関係をインストールします。JS/TS のみ。

オプション​

長押し値 (Value)説明
--path <folder>パス実行時の依存関係を作成およびインストールするターゲット フォルダーです。
uip function runtime-install --path .uipath/runner
uip function runtime-install --path .uipath/runner

データシェイプ(--output json)​

{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }
{ "Code": "RuntimeInstallComplete", "Data": { "Message": "Runtime installed at .uipath/runner" } }

エラー動作​

  • JS/TS プロジェクトまたは検出されない言語に対してinitします: Failure、Message: "'init' is not applicable to JS/TS projects." (または "'init' is Python-only.")、Instructions名前は new --empty/--languageです。
  • 検出可能な言語と--languageのないnew : 既定で TypeScript が使用され、失敗ではなくログに警告が表示されます。
  • 他の動詞 ( Failure、 Message: "No Functions project detected in this directory."、 の 関数プロジェクトが検出されません。uipath.json/package.json/pyproject.tomlを含むディレクトリから実行するInstructionsがあるか、明示的に--language渡します。
  • Node.js が存在しないか v20 未満 (JS/TS パス): 必要なバージョンの名前と、インストールするためのリンクを ConfigError します。このチェックは setup で実行され、 new が JS/TS CLI に転送される前に自動的に実行されます。
  • Python または uipath パッケージが設定されていない (Python パス): uip function setup実行するInstructionsでConfigError。

参照​

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

接続

ヘルプ リソース サポート(opens in new window)

学習する UiPath アカデミー(opens in new window)

質問する UiPath フォーラム(opens in new window)

最新情報を取得