uip 関数

「uip 関数」の構文とオプション - UiPath JS/TS および Python 関数 (setup、new、init、serve、run、pack、push、publish、runtime-install) を構築、提供、パブリッシュします。

uip function は、 UiPath Functions — UiPath Platform 上でパッケージ化および実行される小型の 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 にルーティングします。したがって、転送された動詞のuip function <verb> --helpは、uip作成されたものではなく、基礎となるCLI自身のヘルプを示しています — 以下のオプションテーブルは、転送ラッパー独自のフラグヒントと例から抽出されており、これは下流のCLIが引き継ぐ前にこのリポジトリのツールが公開する最大のものです。
• 言語の解決は、 init と newにとって重要です。init は Python 専用 です。JS/TS の場合は、代わりに new --emptyでスキャフォールディングします。new 自動検出します。検出結果が決定的でない場合は、 --language js|ts|py/pythonを渡さない限り、既定で TypeScript が使用され、ログに記録された警告が表示されます。
• setup 自動的に実行されます。これは、JS / TS CLIに転送する前にNode.js ≥20を確認する非表示のコマンド(--helpnewではありません)です — 通常は自分で呼び出すことはありませんが、キャッシュされた検証が古くなった場合(ノードの再インストール後など)uip function setup --forceチェックを再実行します。
• ターゲット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 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> [--port <port>] [--input <json>]
uip function pack [--nolock]
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 関数 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

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

{ "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

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

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

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

{
  "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

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

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

UIP 関数の run

ローカルの serve エンドポイントに対して関数を呼び出します。JS/TS のみ。

引数

名前	Required	目的
<name>	○	呼び出す関数名です。

オプション

長押し	値 (Value)	説明
--port <port>	integer	ローカル サーバーがオンのポート。既定 7070です。
--input <json>	JSON	入力ペイロード。既定 {}です。

例

uip function run hello --input '{"x":1}'

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

{ "Code": "RunComplete", "Data": { "result": 2 } }

Data は関数自体の戻り値であり、CLI によって正規化されていない、記述した関数によって完全に決定される形状です。

UIP ファンクション パック

デプロイ用にプロジェクトを .nupkg にパックします。

オプション

長押し	値 (Value)	説明
--nolock	フラグ	パッケージからロック ファイルを除外します。JS/TS のみ。

例

uip function pack

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

{ "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

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

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

uip 関数: publish

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

オプション

長押し	値 (Value)	説明
--url <url>	url	UiPath プラットフォームの 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

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

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

uip 関数 runtime-install

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

オプション

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

例

uip function runtime-install --path .uipath/runner

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

{ "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 します。このチェックは、 new が JS/TS CLI に転送される前に自動的に実行されます。

参照

• ツール (プラグイン)
• uip codedapp — コード化されたアプリの同様の形のビルド/パック/パブリッシュ/プッシュ/プルのライフサイクルです。
• グローバル オプション
• 終了コード