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
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. It targets the latest published version by default; pass --version to pin a specific build. Use --folder-key to pick the destination folder when the deployment is folder-scoped.
Synopsis
uip codedapp deploy [options]
uip codedapp deploy [options]
Options
| Flag | Description |
|---|---|
-n, --name <name> | App name. |
--display-name <name> | Human-readable app title shown in UiPath. Defaults to --name as typed. |
--path-name <name> | App pathname in the URL (https://<org>.uipath.host/<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. |
--access-token <token> | Access token (auth override). |
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." }
}
Related
- uip codedapp publish — publish the package that
deployactivates. - uip codedapp pack — produce the
.nupkgconsumed bypublish.