uipath-cli
latest
false
UiPath CLI user guide
- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip model-hub
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-library-object-repository
- get-object-repository
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-instances
- list-workflow-examples
- pack
- publish
- remote
- restore
- run, debug & execution
- run-file
- search-templates
- start-studio
- stop-execution
- tm
- uia
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip codedapp deploy
Syntax and options for `uip codedapp deploy`, which deploys or upgrades a published Coded Web App in UiPath.
uip codedapp deploy deploys or upgrades a published app in UiPath. When the app is already deployed, the command upgrades it in place; otherwise it checks that the path name is free and deploys the app. It targets the latest published version by default; pass --version to pin a specific build. Use --folder-key to pick the destination folder.
Synopsis
uip codedapp deploy [options]
uip codedapp deploy [options]
Options
| Flag | Description |
|---|---|
-n, --name <name> | App name. Converted to the package ID the same way as in pack. When omitted, the name saved in the local app configuration is used; in an interactive terminal without a saved name, the command prompts for it. |
--display-name <name> | Human-readable app title shown in UiPath. When omitted, the title remembered from an earlier deploy is used, then --name as typed. On an upgrade, only an explicit --display-name renames the deployed app. |
--path-name <name> | App pathname in the URL (https://<org>.uipath.host/<path-name>). Defaults to the app name. On an upgrade, the path name changes only when you pass this option. To check whether a path name is free, run uip codedapp validate --path-name. |
--client-id <id> | OAuth client ID override (non-confidential/public client). |
-v, --version <version> | Target a specific published version. Defaults to the latest published version. |
--tags <tags> | Comma-separated categorization labels for the deployed app, e.g. governance,insights. |
--base-url <url> | UiPath base URL (auth override). |
--org-id <id> | Organization ID (auth override). |
--org-name <name> | Organization name (auth override). |
--tenant-id <id> | Tenant ID (auth override). |
--folder-key <key> | Folder key to deploy into. Refer to Folder selection. |
--access-token <token> | Access token (auth override). |
Folder selection
The destination folder is resolved in this order:
--folder-key, when passed. If the app was published into your Personal Workspace, a shared folder key is refused; if it was published into the tenant feed, a Personal Workspace folder key is refused.- The
UIPATH_FOLDER_KEYenvironment variable. - The folders available to your account, filtered to Personal Workspace or shared folders to match how the app was published. When exactly one folder matches, it is selected automatically. When several match, an interactive terminal shows a picker; a non-interactive run fails and asks for
--folder-key. Runuip or folders list --output jsonto find a folder key.
Examples
# Deploy / upgrade to the latest published version
uip codedapp deploy --name "MyApp"
# Pin a specific version
uip codedapp deploy --name "MyApp" --version "1.0.0"
# Deploy into a folder
uip codedapp deploy --name "MyApp" \
--folder-key f0f0f0f0-0000-0000-0000-000000000001
# Separate display title, a custom OAuth client, and system tags
uip codedapp deploy --name "my-app" --display-name "My App" \
--client-id "my-oauth-client-id" --tags governance
# Deploy / upgrade to the latest published version
uip codedapp deploy --name "MyApp"
# Pin a specific version
uip codedapp deploy --name "MyApp" --version "1.0.0"
# Deploy into a folder
uip codedapp deploy --name "MyApp" \
--folder-key f0f0f0f0-0000-0000-0000-000000000001
# Separate display title, a custom OAuth client, and system tags
uip codedapp deploy --name "my-app" --display-name "My App" \
--client-id "my-oauth-client-id" --tags governance
Data shape (--output json)
{
"Code": "DeployCompleted",
"Data": { "message": "App deployed successfully." }
}
{
"Code": "DeployCompleted",
"Data": { "message": "App deployed successfully." }
}
A failed deploy returns Result: "Failure" with Message: "Deploy failed" and the cause in Instructions.
Failure modes
- External application token without Apps scopes. When you sign in with an external application (client credentials) whose token carries no Apps scope, the UiPath Apps service rejects the request. The command fails with
ErrorCode: "permission_denied"and a message naming theApps.ReadandApps.Writescopes. Grant both scopes to the external application, add them touip login --scope, and sign in again. - Path name already taken. A fresh deploy fails when the path name is in use in the organization. Pass a different
--path-name. - Folder key required. A non-interactive run with several candidate folders and no
--folder-keyorUIPATH_FOLDER_KEYfails. - App not published. The command fails when no published version of the app (or of the
--versionyou passed) is found. Runuip codedapp publishfirst.
Related
- uip codedapp publish — publish the package that
deployactivates. - uip codedapp pack — produce the
.nupkgconsumed bypublish.