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 maestro flow pack
Syntax and options for `uip maestro flow pack`, which packages a Flow project directory into a `.nupkg` for Orchestrator publication.
uip maestro flow pack packages a Flow project directory into a .nupkg file ready to publish to Orchestrator.
Synopsis
uip maestro flow pack <projectPath> <outputPath> [-n <name>] [-v <version>] [--author <author>] [--description <text>] [--repository-url <url>] [--repository-commit <sha>] [--repository-branch <branch>] [--repository-type <type>] [--release-notes <text>] [--project-url <url>]
uip maestro flow pack <projectPath> <outputPath> [-n <name>] [-v <version>] [--author <author>] [--description <text>] [--repository-url <url>] [--repository-commit <sha>] [--repository-branch <branch>] [--repository-type <type>] [--release-notes <text>] [--project-url <url>]
Honors global options. Exit codes follow the standard contract.
Arguments
<projectPath>(required) — path to the Flow project directory. The directory must contain the.flowfile named after the package (see Behavior).<outputPath>(required) — output directory where the.nupkgwill be written. Created if it does not exist.
Options
-n, --name <name>— package name. Defaults to the project folder name.-v, --version <version>— package version. Defaults to1.0.0.
Package-metadata options (shared across pack commands)
| Option | Description |
|---|---|
--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. |
--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. |
Behavior
- The command packs
<name>.flowfrom the project directory, where<name>is the package name (--name, or the project folder name). Characters other than letters, numbers,_, and-are replaced with_in the file name. The command fails when that file is missing. - The package name can contain only letters, numbers, dots (
.), underscores (_), and hyphens (-). - Before packing, the command runs the same checks as
uip maestro flow validate, including the designer's rules, without the--strict-bindingsand--strict-expressionsgates. If the.flowfile has errors, the command refuses to pack and lists each error. Fix the errors in the designer, or runuip maestro flow validate <project-path>for the full list. - Packing happens in a temporary staging folder, so the source project is not modified.
Examples
# Pack with defaults (name = folder, version = 1.0.0)
uip maestro flow pack ./invoice-flow ./dist
# Pack with an explicit version
uip maestro flow pack ./invoice-flow ./dist --version 1.2.0
# Pack with defaults (name = folder, version = 1.0.0)
uip maestro flow pack ./invoice-flow ./dist
# Pack with an explicit version
uip maestro flow pack ./invoice-flow ./dist --version 1.2.0
Data shape (--output json)
{
"Code": "FlowPack",
"Data": {
"Package": "[email protected]",
"Output": "/workspace/dist/invoice-flow.flow.Flow.1.2.0.nupkg"
}
}
{
"Code": "FlowPack",
"Data": {
"Package": "[email protected]",
"Output": "/workspace/dist/invoice-flow.flow.Flow.1.2.0.nupkg"
}
}
Package is <name>@<version>. Output is the path of the written .nupkg file.
On failure, the command exits with code 1 and returns Result: "Failure", Message: "Flow pack failed", and the reason in Instructions.
See also
uip maestro flow init— scaffold the project firstuip maestro flow validate— validate before packing- Flow overview