UiPath Documentation
uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。 新发布内容的本地化可能需要 1-2 周的时间才能完成。

UIP 或包

“uip 或 Packages”的语法和选项,用于管理上传到 Orchestrator 订阅源的自动化“.nupkg”工件。

uip or packages 管理已上传到 Orchestrator 订阅源的自动化包(.nupkg 工件)。list、get 和 entry-points 是租户范围,不需要文件夹上下文; versions、upload 和 download 还接受 --folder-path/--folder-key,以文件夹范围内的订阅源而不是租户订阅源为目标。使用uip or processes将包作为可运行流程绑定到文件夹。使用--output-type Library打包的包属于uip or libraries 。

大纲​

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

动词​

动词用途
list列出订阅源中的包。
get通过密钥获取一个包版本。
versions列出包的所有版本。
entry-points列出包版本的工作流入口点(包含输入/输出架构)。
upload将.nupkg上传到订阅源。
delete从订阅源中删除包版本。
download从订阅源下载.nupkg 。

UIP 或包列表​

列出订阅源中的包。返回包版本密钥( PackageId:Version格式)、标题、版本和元数据。

选项​

短长值默认描述
-s--searchtext—按名称搜索包。
—--feed-idGUID租户订阅源以特定订阅源为目标。使用feeds list发现 ID。
—--all-fields标记关闭返回完整的 API 有效负载。
-l--limit数字50页面大小。
—--offset数字0跳过计数。
—--sort-by字段Id descOData 排序。

示例​

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-idGUID租户订阅源以特定订阅源为目标。
—--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-idGUID租户订阅源以特定订阅源为目标。
—--folder-path路径租户订阅源按路径而不是租户订阅源以文件夹范围内的订阅源为目标。
—--folder-keyGUID租户订阅源通过密钥而非租户订阅源来定位文件夹范围内的订阅源。
—--all-fields标记关闭返回完整的 API 有效负载,而不是策划摘要。
-l--limit数字50页面大小。
—--offset数字0跳过计数。
—--sort-by字段Id descOData 排序。

示例​

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-idGUID租户订阅源以特定订阅源为目标。

示例​

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 或包上传​

将流程 .nupkg 包上传到订阅源。上传后,使用 uip or processes create 将其绑定到文件夹。使用--output-type Library打包的包在上传之前就会被拒绝 — 请使用uip or libraries upload或--force ,仍将其放入流程订阅源中。

参数​

名称必填用途
<file>是.nupkg 文件的路径。

选项​

短长值默认描述
—--feed-idGUID租户订阅源上传到特定订阅源。
—--folder-path路径租户订阅源按路径上传到文件夹范围内的订阅源,而不是上传到租户订阅源。
—--folder-keyGUID租户订阅源通过密钥上传到文件夹范围内的订阅源,而不是上传到租户订阅源。
—--force标记false仍然将库包上传到流程订阅源。

示例​

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 或 Packages Delete​

从 Orchestrator 流程订阅源中删除包版本。删除流程绑定的包后,该流程无法运行版本。

参数​

名称必填用途
<key>是包版本密钥(格式为 PackageId:Version,例如 MyProcess:1.0.0)。使用 packages list 或 packages versions 进行查找。

选项​

短长值默认描述
—--feed-idGUID租户订阅源从特定订阅源中删除。
—--folder-path路径租户订阅源按路径(而不是租户订阅源)从文件夹范围的订阅源中删除。
—--folder-keyGUID租户订阅源通过密钥(而不是租户订阅源)从文件夹范围内的订阅源中删除。
-y--yes标记—必需。确认此无法撤销的操作 — CLI 从不提示。

示例​

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 始终存在 — 空字符串表示租户订阅源。文件夹范围内的删除会将 FolderKey 和 FolderPath 添加到 Data。

uip 或包下载​

从订阅源下载.nupkg 。需要--destination 。

参数​

名称必填用途
<key>是包版本密钥(例如MyProcess:1.0.0 )。

选项​

短长值默认描述
—--feed-idGUID租户订阅源以特定订阅源为目标。
—--folder-path路径租户订阅源按路径而不是租户订阅源以文件夹范围内的订阅源为目标。
—--folder-keyGUID租户订阅源通过密钥而非租户订阅源来定位文件夹范围内的订阅源。
-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中的流程密钥(而非包密钥)。

另请参阅​

此页面有帮助吗?

连接

需要帮助? 支持

想要了解详细内容? UiPath Academy

有问题? UiPath 论坛

保持更新