CLI Reference¶

The uip CLI manages the full deployment lifecycle of a coded action app.

Installation¶

npm install -g @uipath/cli

uip tools install codedapp

Minimum versions

Coded Action Apps requires CLI version >= 0.9.0 and codedapp tool version >= 0.9.0. This reference reflects CLI 1.202.1 and codedapp tool 1.202.2; some options are not available in older versions. The validate and delete commands require codedapp tool version >= 1.202.2.

Check your installed CLI version:

uip --version

Check your installed codedapp tool version:

uip tools list

To update the codedapp tool to the latest version:

uip tools update

Authenticate with the UiPath platform.

$ uip login [options]

Name	Type	Description	Default
`--authority`	string	Custom authority URL	`https://cloud.uipath.com`
`-t, --tenant`	string	Tenant name (non-interactive mode)	—
`--organization`	string	Organization logical name to pre-select during browser login	—
`--interactive`	boolean	Prompt to select a tenant from a list	—
`--client-id`	string	Client ID of an External App. Use `env.<NAME>` to read it from an environment variable	—
`--client-secret`	string	Client secret of the External App. Use `env.<NAME>` to read it from an environment variable	—
`-s, --scope`	string	Scopes to request for an External App, comma- or space-separated	—
`--no-browser`	boolean	Print the sign-in URL instead of opening a browser	—

Examples

# Interactive loginuip login --interactive# Specific tenantuip login --tenant MyTenant# Check login statusuip login status# Log out and remove stored credentialsuip logout

init¶

Create a starter app in a new or empty directory. Pass --type Action to create a coded action app.

$ uip codedapp init <path> [options]

Name	Type	Description	Default
`--template`	string	Starter template: `form`, `dashboard`, or `inline-automation`	`form`
`--type`	string	App subtype. Omit for a coded app, or pass `Action` to create a coded action app	—
`--force`	boolean	Overwrite starter files in a non-empty directory	—
`--skip-solution-registration`	boolean	Do not register the project in the surrounding solution	—

Examples

uip codedapp init ./approve-invoice --type Action

Build app¶

Before proceeding, make sure you build your coded action app using your framework's build command from the root of the project:

$ npm run build

This will create the dist (or build) folder.

pack¶

Package a built app into a .nupkg.

$ uip codedapp pack <dist> [options]

Name	Type	Description	Default
`-n, --name`	string	Package name	—
`--display-name`	string	Display name of the app	Value of `--name`
`-v, --version`	string	Package version	`1.0.0`
`--output-dir`	string	Output directory	`./.uipath`
`--author`	string	Package author	`UiPath Developer`
`--description`	string	Package description	Package name
`--main-file`	string	Main entry file	`index.html`
`--content-type`	string	Content type: `webapp`, `library`, or `process`	`webapp`
`--release-notes`	string	Release notes for the package	—
`--repository-url`	string	Source repository URL (recorded in the package for traceability)	—
`--repository-commit`	string	Source repository commit hash (recorded in the package for traceability)	—
`--repository-branch`	string	Source repository branch	—
`--repository-type`	string	Source repository type	`git` when `--repository-url` is set
`--project-url`	string	Automation Hub idea URL	—
`--dry-run`	boolean	Show what would be packaged without creating it	—

Angular dist path

Angular 17+ outputs to dist/<project-name>/browser/. Angular 16 and earlier outputs to dist/<project-name>/.

Output: .uipath/<name>.<version>.nupkg

Examples

uip codedapp pack ./distuip codedapp pack ./dist --name MyAppuip codedapp pack ./dist --name MyApp --version 1.0.0uip codedapp pack ./dist --name my-app --display-name "My App" --version 1.0.0

publish¶

Upload the .nupkg to Orchestrator and register it as a coded action app version. Pass --type Action so the app is registered as an Action Center task interface rather than a standalone web app.

$ uip codedapp publish --type Action [options]

Name	Type	Description	Default
`-n, --name`	string	Package name (non-interactive)	—
`-v, --version`	string	Package version (requires `--name`)	—
`-t, --type`	string	App type: `Web` or `Action`. Use `Action` for coded action apps	`Action` if `action-schema.json` exists in the current directory, otherwise `Web`
`--personal-workspace`	boolean	Publish to your Personal Workspace instead of the tenant	—
`--uipath-dir`	string	UiPath directory containing packages	`./.uipath`
`--base-url`	string	UiPath base URL	—
`--org-id`	string	Organization ID	—
`--org-name`	string	Organization name, used when `--org-id` is not provided	—
`--tenant-id`	string	Tenant ID	—
`--tenant-name`	string	Tenant name	—
`--access-token`	string	Access token	—

Examples

uip codedapp publish --type Actionuip codedapp publish --type Action --name MyAppuip codedapp publish --type Action --name MyApp --version 2.0.0uip codedapp publish --type Action --personal-workspace

validate¶

Check whether a path name is free before deploying. A coded app is served at https://<org>.uipath.host/<path-name>, and path names are unique across the organization. When the name is taken, the command returns the app that holds it.

$ uip codedapp validate --path-name <name> [options]

Name	Type	Description	Default
`--path-name`	string	Path name to check (required)	—
`--base-url`	string	UiPath base URL	—
`--org-id`	string	Organization ID	—
`--org-name`	string	Organization name	—
`--access-token`	string	Access token	—

Note

A taken name is a result, not an error, so both outcomes exit with code 0. Read Available in the output; a non-zero exit means the lookup itself failed (for example, invalid credentials or missing permissions). The path name is sanitized to lowercase letters, digits, and hyphens before the check, the same way deploy sanitizes it.

Examples

uip codedapp validate --path-name my-appuip codedapp validate --path-name my-app --output table

deploy¶

Deploy a published app version to a folder.

$ uip codedapp deploy [options]

Name	Type	Description	Default
`-n, --name`	string	App name	—
`--display-name`	string	Display name of the deployed app	Value of `--name`
`--path-name`	string	App path name in the URL (`https://<org>.uipath.host/<path-name>`)	—
`--client-id`	string	Client ID of a non-confidential External App	—
`-v, --version`	string	Target a specific published version	—
`--tags`	string	Comma-separated labels for the deployed app (e.g. `governance,insights`)	—
`--base-url`	string	UiPath base URL	—
`--org-id`	string	Organization ID	—
`--org-name`	string	Organization name	—
`--tenant-id`	string	Tenant ID	—
`--folder-key`	string	Folder key	—
`--access-token`	string	Access token	—

Examples

uip codedapp deployuip codedapp deploy --name MyAppuip codedapp deploy --name my-app --display-name "My App" --path-name my-app

delete¶

Delete a deployed app from a folder. The published package and deployments in other folders are not affected.

$ uip codedapp delete --display-name <name> --yes [options]

Name	Type	Description	Default
`--display-name`	string	Display name of the deployed app. Case-sensitive (required)	—
`--folder-key`	string	Key of the folder that contains the deployed app. Required unless `UIPATH_FOLDER_KEY` is set	—
`-y, --yes`	boolean	Confirm the deletion (required)	—
`--base-url`	string	UiPath base URL	—
`--org-id`	string	Organization ID	—
`--org-name`	string	Organization name	—
`--tenant-id`	string	Tenant ID	—
`--access-token`	string	Access token	—

Warning

Deletion cannot be undone.

Examples

uip codedapp delete --display-name "My App" --folder-key <folderKey> --yes

push¶

Push local source code to a Studio Web project.

$ uip codedapp push [options]

Name	Type	Description	Default
`--project-id`	string	Studio Web project ID. If omitted and `UIPATH_PROJECT_ID` is not set, you are prompted to create or select a solution (use `--solution-name`/`--project-name` to skip the prompts)	—
`--solution-name`	string	Name of the Studio Web solution to create when no project ID is set. Required with `--project-name` when the CLI cannot prompt	Prompted
`--project-name`	string	Name of the Coded Action App project to create in that solution	Prompted
`--build-dir`	string	Build output directory	`dist`
`-v, --version`	string	Code version to set (e.g. `2.0.0`)	—
`--ignore-resources`	boolean	Skip importing referenced resources	—
`--verbose`	boolean	Show detailed progress logs	—
`--base-url`	string	UiPath base URL	—
`--org-id`	string	Organization ID	—
`--tenant-id`	string	Tenant ID	—
`--access-token`	string	Access token	—

Examples

uip codedapp push --project-id <projectId>uip codedapp push --project-id <projectId> --build-dir builduip codedapp push --solution-name "Product Announcements" --project-name "Announcements Portal"

The first push saves the new project ID to .env as UIPATH_PROJECT_ID, and later pushes use it. --solution-name and --project-name only apply when no project ID is set. If one is set by --project-id, UIPATH_PROJECT_ID, or .env, push fails instead of pushing into that project, so running the same command with these flags a second time fails.

pull¶

Pull project files from a Studio Web project.

$ uip codedapp pull [options]

Name	Type	Description	Default
`--project-id`	string	Studio Web project ID. Required unless `UIPATH_PROJECT_ID` is set	—
`--target-dir`	string	Local directory to write the files to	Current directory
`--overwrite`	boolean	Allow overwriting existing local files	—
`--verbose`	boolean	Show detailed progress logs	—
`--base-url`	string	UiPath base URL	—
`--org-id`	string	Organization ID	—
`--tenant-id`	string	Tenant ID	—
`--access-token`	string	Access token	—

Examples

uip codedapp pull --project-id <projectId>uip codedapp pull --project-id <projectId> --target-dir ./my-app --overwrite

Upgrading / Deploying new version of a coded action app¶

When updating a deployed app, just repeat the build-pack-publish-deploy cycle with a bumped version:

# 1. Rebuildnpm run build# 2. Pack with new versionuip codedapp pack dist -n <appName> --version 2.0.0# 3. Publishuip codedapp publish --type Action# 4. Deploy (auto-detects upgrade)uip codedapp deploy

Global Options¶

These options work with every command.

Name	Type	Description	Default
`--output`	string	Output format: `table`, `json`, `yaml`, or `plain`	`json`
`--output-filter`	string	JMESPath expression applied to the `Data` field of the output	—
`--log-level`	string	Log level: `debug`, `info`, `warn`, or `error`	`info`
`--log-file`	string	Write logs to a file instead of stderr	—
`--profile`	string	Use a named login profile	—

Environment Variables¶

Connection settings can also be set as environment variables (e.g. in CI/CD). Flags override them, and an active uip login session overrides the token, URL, organization, and tenant variables.

Variable	Description
`UIPATH_BASE_URL`	Platform base URL (`UIPATH_URL` is also accepted)
`UIPATH_ORG_ID`	Organization ID (`UIPATH_ORGANIZATION_ID` is also accepted)
`UIPATH_ORG_NAME`	Organization name
`UIPATH_TENANT_NAME`	Tenant name
`UIPATH_TENANT_ID`	Tenant ID
`UIPATH_FOLDER_KEY`	Folder key
`UIPATH_ACCESS_TOKEN`	Bearer token (skips interactive login)
`UIPATH_PROJECT_ID`	Studio Web project ID for push/pull. Also read from a `.env` file in the current directory

Config Files¶

File	Written by	Purpose
`.uipath/.auth`	`uip login`	Access tokens and org/tenant selection. Uses the nearest `.uipath/.auth` in the current or a parent directory, otherwise `~/.uipath/.auth`
`.uipath/app.config.json`	`uip codedapp publish` / `uip codedapp deploy`	App `systemName`, `deployVersion`, `deploymentId` for subsequent runs
`uipath.json`	developer / `uip codedapp pack`	SDK config — read by `pack` and the `@uipath/coded-apps-dev` dev plugin

CLI Reference¶

Installation¶

login¶

init¶

Build app¶

pack¶

publish¶

validate¶

deploy¶

delete¶

push¶

pull¶

Upgrading / Deploying new version of a coded action app¶

Global Options¶

Environment Variables¶

Config Files¶