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 api-workflow pack`, which builds and packages an API Workflow project into a signed or unsigned `.nupkg`.
uip api-workflow pack builds an API Workflow project and packages it into a .nupkg ready to publish. Code signing is optional — pass a .pfx certificate path, password, and timestamp server to produce a signed package.
Synopsis
uip api-workflow pack <projectPath> <destinationPath> [options]
uip api-workflow pack <projectPath> <destinationPath> [options]
<projectPath>— path to the API Workflow project directory or.uipfile.<destinationPath>— directory where the.nupkgis written.
Options
| Flag | Description |
|---|---|
--package-id <id> | NuGet package ID (overrides the project default). |
--package-version <version> | NuGet package version. Defaults to 1.0.0 when omitted or blank. |
--author <author> | Package author. |
--description <text> | Package description. |
--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 but this is omitted. |
--release-notes <text> | Release notes for the package. |
--project-url <url> | Automation Hub idea URL. |
--signing-certificate-path <path> | Path to a .pfx certificate for signing. |
--signing-certificate-password <password> | Certificate password. |
--signing-timestamp-server <url> | Timestamp server URL for signed packages. |
Examples
# Pack with the project's defaults
uip api-workflow pack ./my-workflow ./output
# Override package metadata
uip api-workflow pack ./my-workflow ./output \
--package-id MyOrg.Workflows.Onboarding \
--package-version 1.2.0 \
--author "Contoso Ltd." \
--repository-url https://github.com/contoso/onboarding-workflow
# Sign the package
uip api-workflow pack ./my-workflow ./output \
--signing-certificate-path ./certs/codesign.pfx \
--signing-certificate-password "$CERT_PASSWORD" \
--signing-timestamp-server http://timestamp.digicert.com
# Pack with the project's defaults
uip api-workflow pack ./my-workflow ./output
# Override package metadata
uip api-workflow pack ./my-workflow ./output \
--package-id MyOrg.Workflows.Onboarding \
--package-version 1.2.0 \
--author "Contoso Ltd." \
--repository-url https://github.com/contoso/onboarding-workflow
# Sign the package
uip api-workflow pack ./my-workflow ./output \
--signing-certificate-path ./certs/codesign.pfx \
--signing-certificate-password "$CERT_PASSWORD" \
--signing-timestamp-server http://timestamp.digicert.com
Data shape (--output json)
{
"Code": "ApiWorkflowPack",
"Data": {
"Success": true,
"Packages": ["./output/my-workflow.1.0.0.nupkg"]
}
}
{
"Code": "ApiWorkflowPack",
"Data": {
"Success": true,
"Packages": ["./output/my-workflow.1.0.0.nupkg"]
}
}
Related
- uip api-workflow build — fast compile-only check before packing.
- uip api-workflow run — execute the workflow locally before packaging.