- 概述
- 开始使用
- 概念
- 使用 UiPath CLI
- 操作指南
- CI/CD 方法
- 命令参考
- 迁移
- 参考与支持
“uip 或 Packages”的语法和选项,用于管理上传到 Orchestrator 订阅源的自动化“.nupkg”工件。
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.
大纲
uip or packages <verb> [options]
uip or packages <verb> [options]
动词
| 动词 | 用途 |
|---|---|
list | 列出订阅源中的包。 |
get | 通过密钥获取一个包版本。 |
versions | 列出包的所有版本。 |
entry-points | 列出包版本的工作流入口点(包含输入/输出架构)。 |
upload | 将.nupkg上传到订阅源。 |
delete | Delete a package version from the feed. |
download | 从订阅源下载.nupkg 。 |
UIP 或包列表
列出订阅源中的包。返回包版本密钥( PackageId:Version格式)、标题、版本和元数据。
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
-s | --search | text | — | 按名称搜索包。 |
| — | --feed-id | GUID | 租户订阅源 | 以特定订阅源为目标。使用feeds list发现 ID。 |
| — | --all-fields | 标记 | 关闭 | 返回完整的 API 有效负载。 |
-l | --limit | 数字 | 50 | 页面大小。 |
| — | --offset | 数字 | 0 | 跳过计数。 |
| — | --sort-by | 字段 | Id desc | OData 排序。 |
示例
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}'
数据形状(--输出 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 或包获取
获取特定的包版本。密钥格式为PackageId:Version 。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<key> | 是 | 包版本密钥(例如MyProcess:1.0.0 )。 |
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --feed-id | GUID | 租户订阅源 | 以特定订阅源为目标。 |
| — | --all-fields | 标记 | 关闭 | 返回完整的 API 有效负载。 |
示例
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'
数据形状(--输出 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 或软件包版本
列出包的所有版本。在调用processes create --package-version之前使用此选项。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<package-id> | 是 | 包 ID(例如MyProcess )。 |
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --feed-id | GUID | 租户订阅源 | 以特定订阅源为目标。 |
| — | --folder-path | 路径 | 租户订阅源 | Target a folder-scoped feed by path instead of the tenant feed. |
| — | --folder-key | GUID | 租户订阅源 | Target a folder-scoped feed by key instead of the tenant feed. |
| — | --all-fields | 标记 | 关闭 | 返回完整的 API 有效负载,而不是策划摘要。 |
-l | --limit | 数字 | 50 | 页面大小。 |
| — | --offset | 数字 | 0 | 跳过计数。 |
| — | --sort-by | 字段 | Id desc | OData 排序。 |
示例
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"
数据形状(--输出 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 或包入口点
列出包版本的工作流入口点,包括输入/输出参数架构。对于多入口点包,将入口点路径与processes create --entry-point一起使用。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<key> | 是 | 包版本密钥(例如MyProcess:1.0.0 )。 |
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --feed-id | GUID | 租户订阅源 | 以特定订阅源为目标。 |
示例
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
数据形状(--输出 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 或包上传
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.
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<file> | 是 | .nupkg 文件的路径。 |
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --feed-id | GUID | 租户订阅源 | 上传到特定订阅源。 |
| — | --folder-path | 路径 | 租户订阅源 | Upload to a folder-scoped feed by path instead of the tenant feed. |
| — | --folder-key | GUID | 租户订阅源 | Upload to a folder-scoped feed by key instead of the tenant feed. |
| — | --force | 标记 | false | Upload a library package to the processes feed anyway. |
示例
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"
数据形状(--输出 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.
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<key> | 是 | Package version key (format PackageId:Version, for example MyProcess:1.0.0). Use packages list or packages versions to find it. |
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --feed-id | GUID | 租户订阅源 | Delete from a specific feed. |
| — | --folder-path | 路径 | 租户订阅源 | Delete from a folder-scoped feed by path instead of the tenant feed. |
| — | --folder-key | GUID | 租户订阅源 | Delete from a folder-scoped feed by key instead of the tenant feed. |
-y | --yes | 标记 | — | Required. Confirm this irreversible operation — the CLI never prompts. |
示例
uip or packages delete InvoiceProcessing:1.0.3 --yes
uip or packages delete InvoiceProcessing:1.0.3 --yes
数据形状(--输出 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 或包下载
从订阅源下载.nupkg 。需要--destination 。
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<key> | 是 | 包版本密钥(例如MyProcess:1.0.0 )。 |
选项
| 短 | 长 | 值 | 默认 | 描述 |
|---|---|---|---|---|
| — | --feed-id | GUID | 租户订阅源 | 以特定订阅源为目标。 |
| — | --folder-path | 路径 | 租户订阅源 | Target a folder-scoped feed by path instead of the tenant feed. |
| — | --folder-key | GUID | 租户订阅源 | Target a folder-scoped feed by key instead of the tenant feed. |
-d | --destination | 路径 | 必填 | 下载的.nupkg的保存位置。 |
示例
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'
数据形状(--输出 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"
}
}
退出代码
请参阅退出代码。没有动词特定的覆盖。
相关命令
uip or processes— 将包作为流程绑定到文件夹。uip or feeds— 发现可用的订阅源 ID。uip or jobs— 尤其是jobs start,它使用processes list中的流程密钥(而非包密钥)。
另请参阅
- 全局选项。