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 pack`, which packages a built coded app into a `.nupkg` archive for publication.
uip codedapp pack packages a built coded app into a .nupkg archive ready for publication. It reads the <dist> directory, applies the supplied package metadata, and writes the archive to --output-dir (defaults to ./.uipath). Use --dry-run to preview the file list without writing the archive. This is a local, unauthenticated packaging step — it accepts no login/auth-override flags; those only apply to push/pull/publish/deploy.
Synopsis
uip codedapp pack <dist> [options]
uip codedapp pack <dist> [options]
<dist>— path to the dist folder containing the built application.
Options
| Flag | Description |
|---|---|
-n, --name <name> | Package name. |
--display-name <name> | Human-readable app title shown in UiPath. Defaults to --name as typed. |
-v, --version <version> | Package version. Default: 1.0.0. |
--output-dir <dir> | Output directory. Default: ./.uipath. |
--author <author> | Package author. Default: UiPath Developer. |
--description <desc> | Package description. |
--main-file <file> | Main entry file. Default: index.html. |
--content-type <type> | Content type: webapp, library, or process. Default: webapp. |
--repository-url <url> | Source repository URL, recorded in the package for traceability. |
--repository-commit <sha> | Source repository commit hash, recorded for traceability. |
--repository-branch <branch> | Source repository branch. |
--repository-type <type> | Source repository type. Defaults to git when --repository-url is set. |
--release-notes <text> | Release notes for the package. |
--project-url <url> | Automation Hub idea URL. |
--dry-run | Show what would be packaged without writing the archive. |
Examples
# Default — writes ./.uipath/MyApp.1.0.0.nupkg
uip codedapp pack ./dist --name "MyApp" --version "1.0.0"
# Custom output directory and author
uip codedapp pack ./dist \
--name "MyApp" --version "2.0.0" \
--output-dir ./packages \
--author "Contoso Ltd."
# Separate display title — package id stays my-app
uip codedapp pack ./dist --name "my-app" --display-name "My App" --version "1.0.0"
# Preview the file list — no archive written
uip codedapp pack ./dist --name "MyApp" --dry-run
# Default — writes ./.uipath/MyApp.1.0.0.nupkg
uip codedapp pack ./dist --name "MyApp" --version "1.0.0"
# Custom output directory and author
uip codedapp pack ./dist \
--name "MyApp" --version "2.0.0" \
--output-dir ./packages \
--author "Contoso Ltd."
# Separate display title — package id stays my-app
uip codedapp pack ./dist --name "my-app" --display-name "My App" --version "1.0.0"
# Preview the file list — no archive written
uip codedapp pack ./dist --name "MyApp" --dry-run
Data shape (--output json)
{
"Code": "PackCompleted",
"Data": {
"Message": "Package created successfully.",
"Package": "myapp@1.0.0",
"Output": ".uipath/myapp.1.0.0.nupkg"
}
}
{
"Code": "PackCompleted",
"Data": {
"Message": "Package created successfully.",
"Package": "myapp@1.0.0",
"Output": ".uipath/myapp.1.0.0.nupkg"
}
}
A dry run (--dry-run) returns Code: "PackDryRunCompleted" and Data: { DryRun: true, Message: "Dry run - no package created.", Package, Output } instead — no archive is written, but Output still shows the path it would take.
Related
- uip codedapp push — ship the source to Studio Web before packaging it.
- uip codedapp publish — upload the resulting
.nupkgto UiPath.