uip function

Syntax and options for `uip function`, which builds, serves, and publishes UiPath JS/TS and Python Functions — setup, new, init, serve, run, pack, push, publish, runtime-install.

uip function builds, serves, and publishes UiPath Functions — small JS/TS or Python handlers packaged and run on the UiPath platform. uip function is the canonical group name; uip functions (plural) still works as a back-compat alias.

概念

• This is a language dispatcher, not a native tool. Every verb except setup is a thin forwarder: the CLI detects your project's language (from uipath.json, package.json, or pyproject.toml in the current directory, or --language/-l on new) and routes the raw arguments to either an in-process JS/TS CLI (@uipath/coded-functions-js-cli) or a spawned Python CLI. uip function <verb> --help for any forwarded verb therefore shows the underlying CLI's own help, not a uip-authored one — the options tables below are extracted from the forwarding wrapper's own flag hints and examples, which is the most this repo's tooling exposes before the downstream CLI takes over.
• Language resolution matters for init and new. init is Python-only — for JS/TS, scaffold instead with new --empty. new auto-detects; when detection is inconclusive, it defaults to TypeScript with a logged warning, unless you pass --language js|ts|py/python.
• setup runs automatically. It's a hidden command (not in --help) that verifies Node.js ≥20 before new forwards to the JS/TS CLI — you don't normally call it yourself, but uip function setup --force re-runs the check if the cached verification goes stale (e.g. after a Node reinstall).
• publish vs. push target different destinations: publish uploads the packed .nupkg to an Orchestrator feed; push syncs the project directly into a Studio Web project. Both accept --url/--org/--token (or the matching UIPATH_URL/UIPATH_ORGANIZATION_NAME/UIPATH_ACCESS_TOKEN env vars).
• Solution auto-registration. A successful Python init auto-registers the project into a parent .uipx solution when one exists (same pattern as agent/case/flow init) — pass --skip-solution-registration to opt out. This reports via a separate FunctionsInitSolutionRegistration success envelope after the underlying Python CLI's own init output.

概要

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 function new

Scaffold a new Functions project, including a hello-world function by default.

引数

名前	Required	目的
[name]	×	Project name / directory. Default my-functions. May also be passed as --name.

オプション

長押し	値 (Value)	説明
--name <name>	string	Alternative to the positional argument.
-l, --language <lang>	ts (default) | js | py/python	Project language.
--empty	フラグ	Skip the hello-world function — empty project. JS/TS only.

例

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 function init

Python-only: discover entrypoints and (re)generate entry-points.json/bindings.json/project.uiproj. Must run before pack/push for a Python project. For JS/TS, use new --empty instead — init fails with an explicit "Python-only" error against a JS/TS project or an undetected language.

オプション

長押し	値 (Value)	説明
--language py	flag/value	Force Python language resolution when detection would otherwise be ambiguous.
--skip-solution-registration	フラグ	Do not auto-register the project in a parent .uipx solution.

例

uip function init

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

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

Followed by a second success envelope reporting solution registration:

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

SolutionRegistration.Status is "NotInSolution" when no parent solution exists, or "OptedOut" when --skip-solution-registration was passed — always present, never omitted.

uip function serve

Start the local function server with hot reload. JS/TS only.

オプション

長押し	値 (Value)	説明
--port <port>	integer	Port to listen on. Default 7070.
--runtime <runtime>	node (既定) | deno	Runtime to serve under.

例

uip function serve

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

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

uip function run

Invoke a function against the local serve endpoint. JS/TS only.

引数

名前	Required	目的
<name>	○	Function name to invoke.

オプション

長押し	値 (Value)	説明
--port <port>	integer	Port the local server is on. Default 7070.
--input <json>	JSON	Input payload. Default {}.

例

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

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

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

Data is the function's own return value, shape determined entirely by the function you wrote — not normalized by the CLI.

uip function pack

Pack the project into a .nupkg for deployment.

オプション

長押し	値 (Value)	説明
--nolock	フラグ	Exclude the lock file from the package. JS/TS only.

例

uip function pack

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

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

uip function push

Sync the project to Studio Web — generates entry points and uploads changed files.

オプション

長押し	値 (Value)	Required	説明
--url <url>	url	×	UiPath platform URL. Falls back to UIPATH_URL.
--project-id <id>	GUID	conditionally	Studio Web project ID. Mandatory, but may come from UIPATH_PROJECT_ID instead of the flag.
--org <org>	string	×	Organization name. Falls back to UIPATH_ORGANIZATION_NAME.
--token <token>	string	×	Access token. Falls back to UIPATH_ACCESS_TOKEN.

例

uip function push --project-id 1f2a3b4c-0000-0000-0000-000000000001

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

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

uip function publish

Upload the latest .nupkg to an Orchestrator folder. Without --feed-id, prompts interactively for a feed (ESC to cancel) — pass --feed-id for CI use to skip the picker.

オプション

長押し	値 (Value)	説明
--url <url>	url	UiPath platform URL. Falls back to UIPATH_URL.
--org <org>	string	Organization name. Falls back to UIPATH_ORGANIZATION_NAME.
--token <token>	string	Access token. Falls back to UIPATH_ACCESS_TOKEN.
--feed-id <id>	GUID	Feed to publish to — skips the interactive picker.

例

# 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 function runtime-install

Create a runner folder with its own package.json and install runtime dependencies into it. JS/TS only.

オプション

長押し	値 (Value)	説明
--path <folder>	パス	Target folder to create and install runtime dependencies into.

例

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

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

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

エラー動作

• init against a JS/TS project or an undetected language: Failure, Message: "'init' is not applicable to JS/TS projects." (or "'init' is Python-only."), with Instructions naming new --empty/--language.
• new with no detectable language and no --language: defaults to TypeScript with a logged warning rather than failing.
• No Functions project detected for any other verb: Failure, Message: "No Functions project detected in this directory.", with Instructions to run from a directory containing uipath.json/package.json/pyproject.toml, or pass --language explicitly.
• Node.js missing or below v20 (JS/TS path): ConfigError naming the required version and a link to install it — this check runs automatically before new forwards to the JS/TS CLI.

参照

• ツール (プラグイン)
• uip codedapp — a similarly-shaped build/pack/publish/push/pull lifecycle for coded apps.
• グローバル オプション
• 終了コード