UiPath CLI - uip or packages

uipath-cli

latest

false

UiPath CLI user guide

uip or packages

Syntax and options for `uip or packages`, which manages automation `.nupkg` artifacts uploaded to an Orchestrator feed.

uip or packages manages the automation packages (.nupkg artifacts) uploaded to an Orchestrator feed. list, get, and entry-points are tenant-scoped and need no folder context; versions, upload, and download additionally accept --folder-path/--folder-key to target a folder-scoped feed instead of the tenant feed. Use uip or processes to bind a package to a folder as a runnable process. Packages packed with --output-type Library belong to uip or libraries instead.

Synopsis

uip or packages <verb> [options]
uip or packages <verb> [options]

Verbs

Verb	Purpose
`list`	List packages in the feed.
`get`	Fetch one package version by key.
`versions`	List all versions of a package.
`entry-points`	List workflow entry points (with input/output schemas) for a package version.
`upload`	Upload a `.nupkg` to the feed.
`delete`	Delete a package version from the feed.
`download`	Download a `.nupkg` from the feed.

uip or packages list

List packages in the feed. Returns the package version key (format PackageId:Version), title, version, and metadata.

Options

Short	Long	Value	Default	Description
`-s`	`--search`	text	—	Search packages by name.
—	`--feed-id`	GUID	tenant feed	Target a specific feed. Use `feeds list` to discover IDs.
—	`--all-fields`	flag	off	Return the full API payload.
`-l`	`--limit`	number	`50`	Page size.
—	`--offset`	number	`0`	Skip count.
—	`--sort-by`	field	`Id desc`	OData sort.

Examples

uip or packages list
uip or packages list --search Invoice --limit 20
uip or packages list --output-filter 'Data[].{id:Id, v:Version}'
uip or packages list
uip or packages list --search Invoice --limit 20
uip or packages list --output-filter 'Data[].{id:Id, v:Version}'

Data shape (--output json)

{
  "Code": "PackageList",
  "Data": [
    {
      "Key": "InvoiceProcessing:1.0.2",
      "Title": "InvoiceProcessing",
      "Version": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "IsActive": true,
      "PackageType": "Process",
      "TargetFramework": "Windows",
      "Authors": "Finance Team",
      "Published": "2025-04-10T08:00:00Z",
      "Id": "InvoiceProcessing"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}
{
  "Code": "PackageList",
  "Data": [
    {
      "Key": "InvoiceProcessing:1.0.2",
      "Title": "InvoiceProcessing",
      "Version": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "IsActive": true,
      "PackageType": "Process",
      "TargetFramework": "Windows",
      "Authors": "Finance Team",
      "Published": "2025-04-10T08:00:00Z",
      "Id": "InvoiceProcessing"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

uip or packages get

Fetch a specific package version. The key format is PackageId:Version.

Arguments

Name	Required	Purpose
`<key>`	yes	Package version key (for example, `MyProcess:1.0.0`).

Options

Short	Long	Value	Default	Description
—	`--feed-id`	GUID	tenant feed	Target a specific feed.
—	`--all-fields`	flag	off	Return the full API payload.

Examples

uip or packages get InvoiceProcessing:1.0.2
uip or packages get InvoiceProcessing:1.0.2 --all-fields
uip or packages get InvoiceProcessing:1.0.2 --output-filter 'Data.ReleaseNotes'
uip or packages get InvoiceProcessing:1.0.2
uip or packages get InvoiceProcessing:1.0.2 --all-fields
uip or packages get InvoiceProcessing:1.0.2 --output-filter 'Data.ReleaseNotes'

Data shape (--output json)

{
  "Code": "PackageGet",
  "Data": {
    "Key": "InvoiceProcessing:1.0.2",
    "Title": "InvoiceProcessing",
    "Version": "1.0.2",
    "Description": "Processes vendor invoices",
    "IsLatestVersion": true,
    "IsActive": true,
    "PackageType": "Process",
    "TargetFramework": "Windows",
    "Authors": "Finance Team",
    "Published": "2025-04-10T08:00:00Z",
    "ReleaseNotes": "Fix amount rounding bug",
    "Id": "InvoiceProcessing"
  }
}
{
  "Code": "PackageGet",
  "Data": {
    "Key": "InvoiceProcessing:1.0.2",
    "Title": "InvoiceProcessing",
    "Version": "1.0.2",
    "Description": "Processes vendor invoices",
    "IsLatestVersion": true,
    "IsActive": true,
    "PackageType": "Process",
    "TargetFramework": "Windows",
    "Authors": "Finance Team",
    "Published": "2025-04-10T08:00:00Z",
    "ReleaseNotes": "Fix amount rounding bug",
    "Id": "InvoiceProcessing"
  }
}

uip or packages versions

List all versions of a package. Use this before calling processes create --package-version.

Arguments

Name	Required	Purpose
`<package-id>`	yes	Package ID (for example, `MyProcess`).

Options

Short	Long	Value	Default	Description
—	`--feed-id`	GUID	tenant feed	Target a specific feed.
—	`--folder-path`	path	tenant feed	Target a folder-scoped feed by path instead of the tenant feed.
—	`--folder-key`	GUID	tenant feed	Target a folder-scoped feed by key instead of the tenant feed.
—	`--all-fields`	flag	off	Return the full API payload instead of the curated summary.
`-l`	`--limit`	number	`50`	Page size.
—	`--offset`	number	`0`	Skip count.
—	`--sort-by`	field	`Id desc`	OData sort.

Examples

uip or packages versions InvoiceProcessing
uip or packages versions InvoiceProcessing --limit 5
uip or packages versions InvoiceProcessing \
    --output-filter 'Data[?IsLatestVersion].Version | [0]'

# From a folder-scoped feed instead of the tenant feed
uip or packages versions InvoiceProcessing --folder-path "Shared"
uip or packages versions InvoiceProcessing
uip or packages versions InvoiceProcessing --limit 5
uip or packages versions InvoiceProcessing \
    --output-filter 'Data[?IsLatestVersion].Version | [0]'

# From a folder-scoped feed instead of the tenant feed
uip or packages versions InvoiceProcessing --folder-path "Shared"

Data shape (--output json)

{
  "Code": "PackageVersionList",
  "Data": [
    {
      "Key": "InvoiceProcessing:1.0.2",
      "Title": "InvoiceProcessing",
      "Version": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "IsActive": true,
      "PackageType": "Process",
      "TargetFramework": "Windows",
      "Authors": "Finance Team",
      "Published": "2025-04-10T08:00:00Z",
      "Id": "InvoiceProcessing"
    }
  ]
}
{
  "Code": "PackageVersionList",
  "Data": [
    {
      "Key": "InvoiceProcessing:1.0.2",
      "Title": "InvoiceProcessing",
      "Version": "1.0.2",
      "Description": "",
      "IsLatestVersion": true,
      "IsActive": true,
      "PackageType": "Process",
      "TargetFramework": "Windows",
      "Authors": "Finance Team",
      "Published": "2025-04-10T08:00:00Z",
      "Id": "InvoiceProcessing"
    }
  ]
}

uip or packages entry-points

List workflow entry points for a package version, including input/output argument schemas. Use the entry-point path with processes create --entry-point for multi-entry-point packages.

Arguments

Name	Required	Purpose
`<key>`	yes	Package version key (for example, `MyProcess:1.0.0`).

Options

Short	Long	Value	Default	Description
—	`--feed-id`	GUID	tenant feed	Target a specific feed.

Examples

uip or packages entry-points InvoiceProcessing:1.0.2
uip or packages entry-points InvoiceProcessing:1.0.2 \
    --output-filter 'Data[].Path'
uip or packages entry-points InvoiceProcessing:1.0.2 --output table
uip or packages entry-points InvoiceProcessing:1.0.2
uip or packages entry-points InvoiceProcessing:1.0.2 \
    --output-filter 'Data[].Path'
uip or packages entry-points InvoiceProcessing:1.0.2 --output table

Data shape (--output json)

{
  "Code": "PackageEntryPoints",
  "Data": [
    {
      "UniqueId": "a1b2c3d4-0000-0000-0000-000000000001",
      "Path": "Main.xaml",
      "DisplayName": "Main",
      "InputArguments": "{\"invoicePath\":\"String\"}",
      "OutputArguments": "{\"result\":\"String\"}"
    }
  ]
}
{
  "Code": "PackageEntryPoints",
  "Data": [
    {
      "UniqueId": "a1b2c3d4-0000-0000-0000-000000000001",
      "Path": "Main.xaml",
      "DisplayName": "Main",
      "InputArguments": "{\"invoicePath\":\"String\"}",
      "OutputArguments": "{\"result\":\"String\"}"
    }
  ]
}

uip or packages upload

Upload a process .nupkg package to the feed. After upload, bind it to a folder with uip or processes create. A package packed with --output-type Library is rejected before upload — use uip or libraries upload, or --force to put it in the processes feed anyway.

Arguments

Name	Required	Purpose
`<file>`	yes	Path to the `.nupkg` file.

Options

Short	Long	Value	Default	Description
—	`--feed-id`	GUID	tenant feed	Upload to a specific feed.
—	`--folder-path`	path	tenant feed	Upload to a folder-scoped feed by path instead of the tenant feed.
—	`--folder-key`	GUID	tenant feed	Upload to a folder-scoped feed by key instead of the tenant feed.
—	`--force`	flag	`false`	Upload a library package to the processes feed anyway.

Examples

uip or packages upload ./InvoiceProcessing.1.0.3.nupkg
uip or packages upload ./dist/MyProcess.2.0.0.nupkg --feed-id a1b2c3d4-0000-0000-0000-000000000001
uip or packages upload ./InvoiceProcessing.1.0.3.nupkg --output-filter 'Data[0].body'

# Upload to a folder-scoped feed instead of the tenant feed
uip or packages upload ./InvoiceProcessing.1.0.3.nupkg --folder-path "Shared"
uip or packages upload ./InvoiceProcessing.1.0.3.nupkg
uip or packages upload ./dist/MyProcess.2.0.0.nupkg --feed-id a1b2c3d4-0000-0000-0000-000000000001
uip or packages upload ./InvoiceProcessing.1.0.3.nupkg --output-filter 'Data[0].body'

# Upload to a folder-scoped feed instead of the tenant feed
uip or packages upload ./InvoiceProcessing.1.0.3.nupkg --folder-path "Shared"

Data shape (--output json)

{
  "Code": "PackageUploaded",
  "Data": [
    {
      "key": "InvoiceProcessing.1.0.3.nupkg",
      "status": "Created",
      "body": "InvoiceProcessing:1.0.3"
    }
  ]
}
{
  "Code": "PackageUploaded",
  "Data": [
    {
      "key": "InvoiceProcessing.1.0.3.nupkg",
      "status": "Created",
      "body": "InvoiceProcessing:1.0.3"
    }
  ]
}

uip or packages delete

Delete a package version from the Orchestrator processes feed. Deleting a package a process is bound to leaves that process without a version to run.

Arguments

Name	Required	Purpose
`<key>`	yes	Package version key (format `PackageId:Version`, for example `MyProcess:1.0.0`). Use `packages list` or `packages versions` to find it.

Options

Short	Long	Value	Default	Description
—	`--feed-id`	GUID	tenant feed	Delete from a specific feed.
—	`--folder-path`	path	tenant feed	Delete from a folder-scoped feed by path instead of the tenant feed.
—	`--folder-key`	GUID	tenant feed	Delete from a folder-scoped feed by key instead of the tenant feed.
`-y`	`--yes`	flag	—	Required. Confirm this irreversible operation — the CLI never prompts.

Examples

uip or packages delete InvoiceProcessing:1.0.3 --yes
uip or packages delete InvoiceProcessing:1.0.3 --yes

Data shape (--output json)

{
  "Code": "PackageDeleted",
  "Data": {
    "Key": "InvoiceProcessing:1.0.3",
    "FeedId": "",
    "Status": "Package deleted"
  }
}
{
  "Code": "PackageDeleted",
  "Data": {
    "Key": "InvoiceProcessing:1.0.3",
    "FeedId": "",
    "Status": "Package deleted"
  }
}

FeedId is always present — an empty string means the tenant feed. A folder-scoped delete adds FolderKey and FolderPath to Data.

uip or packages download

Download a .nupkg from the feed. Requires --destination.

Arguments

Name	Required	Purpose
`<key>`	yes	Package version key (for example, `MyProcess:1.0.0`).

Options

Short	Long	Value	Default	Description
—	`--feed-id`	GUID	tenant feed	Target a specific feed.
—	`--folder-path`	path	tenant feed	Target a folder-scoped feed by path instead of the tenant feed.
—	`--folder-key`	GUID	tenant feed	Target a folder-scoped feed by key instead of the tenant feed.
`-d`	`--destination`	path	required	Where to save the downloaded `.nupkg`.

Examples

uip or packages download InvoiceProcessing:1.0.2 \
    --destination ./InvoiceProcessing.1.0.2.nupkg

uip or packages download InvoiceProcessing:1.0.2 -d /tmp/ip.nupkg \
    --feed-id a1b2c3d4-0000-0000-0000-000000000001

uip or packages download InvoiceProcessing:1.0.2 -d ./ip.nupkg \
    --output-filter 'Data.SavedTo'
uip or packages download InvoiceProcessing:1.0.2 \
    --destination ./InvoiceProcessing.1.0.2.nupkg

uip or packages download InvoiceProcessing:1.0.2 -d /tmp/ip.nupkg \
    --feed-id a1b2c3d4-0000-0000-0000-000000000001

uip or packages download InvoiceProcessing:1.0.2 -d ./ip.nupkg \
    --output-filter 'Data.SavedTo'

Data shape (--output json)

{
  "Code": "PackageDownloaded",
  "Data": {
    "Key": "InvoiceProcessing:1.0.2",
    "SavedTo": "./InvoiceProcessing.1.0.2.nupkg",
    "Size": "512000 bytes"
  }
}
{
  "Code": "PackageDownloaded",
  "Data": {
    "Key": "InvoiceProcessing:1.0.2",
    "SavedTo": "./InvoiceProcessing.1.0.2.nupkg",
    "Size": "512000 bytes"
  }
}

Exit codes

See Exit codes. No verb-specific overrides.

uip or processes — bind a package to a folder as a process.
uip or feeds — discover available feed IDs.
uip or jobs — especially jobs start, which uses the process key (not the package key) from processes list.

Was this page helpful?

PREVIOUSprocesses

NEXTmachines

Synopsis​

Verbs​

uip or packages list​

Options​

Examples​

Data shape (--output json)​

uip or packages get​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or packages versions​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or packages entry-points​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or packages upload​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or packages delete​

Arguments​

Options​

Examples​

Data shape (--output json)​

uip or packages download​

Arguments​

Options​

Examples​

Data shape (--output json)​

Exit codes​

Related commands​

See also​

Was this page helpful?

Synopsis

Verbs

uip or packages list

Options

Examples

Data shape (--output json)

uip or packages get

Arguments

Options

Examples

Data shape (--output json)

uip or packages versions

Arguments

Options

Examples

Data shape (--output json)

uip or packages entry-points

Arguments

Options

Examples

Data shape (--output json)

uip or packages upload

Arguments

Options

Examples

Data shape (--output json)

uip or packages delete

Arguments

Options

Examples

Data shape (--output json)

uip or packages download

Arguments

Options

Examples

Data shape (--output json)

Exit codes

Related commands

See also