- 概述
- 开始使用
- 概念
- 使用 UiPath CLI
- 操作指南
- CI/CD 方法
- 命令参考
- 迁移
- 参考与支持
Syntax and options for `uip aops project` and `uip aops solution`, which inspect automation projects and Studio solutions discovered through a SourceControl connection.
uip aops project inspects a single automation project's files, content, and commit history. uip aops solution does the same for a Studio solution. Both are read-only against the underlying Git repository — discover identifiers first with connection projects/connection solutions. See the uip aops overview for shared concepts.
大纲
uip aops project list [--connections <csv>] [--target-framework <name>] [--project-type <type>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops project get --project-id <id> [--reference <ref>] [--with-branches]
uip aops project files --project-id <id> [--path <path>] [--reference <ref>]
uip aops project content --project-id <id> --path <path> [--reference <ref>]
uip aops project commits --project-id <id> [--path <path>] [--branch <name>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops project commit --project-id <id> --reference <sha>
uip aops solution get <solution-id>
uip aops solution commits <solution-id> [--path <path>] [--branch <name>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops project list [--connections <csv>] [--target-framework <name>] [--project-type <type>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops project get --project-id <id> [--reference <ref>] [--with-branches]
uip aops project files --project-id <id> [--path <path>] [--reference <ref>]
uip aops project content --project-id <id> --path <path> [--reference <ref>]
uip aops project commits --project-id <id> [--path <path>] [--branch <name>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops project commit --project-id <id> --reference <sha>
uip aops solution get <solution-id>
uip aops solution commits <solution-id> [--path <path>] [--branch <name>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops project list
List projects across every visible SourceControl connection (a cross-connection aggregator — most other project verbs target one project by --project-id).
选项
| 长 | 值 | 描述 |
|---|---|---|
--connections <csv> | comma-separated | Connection identifiers to fan out to. Defaults to every visible connection. |
--target-framework <name> | 字符串 | Server-side filter on project target framework. |
--project-type <type> | 字符串 | Server-side filter on project type, e.g. Process, Library, Agent. |
--offset <n> | 整数 | Number to skip per connection. Must be a multiple of --limit. Default 0. |
--limit <n> | 整数 | Maximum to return per connection. Default 10. |
--search <term> | 字符串 | Server-side substring filter on project name. |
This fans out to every connection in parallel and degrades rather than fails: if some connections can't be read, the reachable projects are still returned and the envelope carries a Warning naming the connections that were skipped — a short list is never mistaken for a complete one. Only a total, all-connections failure is an error. Re-run with --log-level warn to see each connection's underlying error.
示例
uip aops project list
uip aops project list --connections f1e2d3c4-0000-0000-0000-000000000001 --search invoice
uip aops project list
uip aops project list --connections f1e2d3c4-0000-0000-0000-000000000001 --search invoice
数据形状(--输出 json)
{
"Code": "ProjectList",
"Data": [
{ "ProjectId": "9999dddd-0000-0000-0000-000000000001", "Name": "Invoice Processing", "Description": "Daily invoice ingest", "Type": "Process", "Repository": "automation-hub" }
]
}
{
"Code": "ProjectList",
"Data": [
{ "ProjectId": "9999dddd-0000-0000-0000-000000000001", "Name": "Invoice Processing", "Description": "Daily invoice ingest", "Type": "Process", "Repository": "automation-hub" }
]
}
uip aops project get
Fetch a project's metadata at a given reference.
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--project-id <id> | 字符串 | 是 | SC service UUID for the project, from connection projects. |
--reference <ref> | branch/tag/SHA | 否 | Defaults to the default branch's HEAD. |
--with-branches | 标记 | 否 | Also fetch the full branch list and include it as availableBranches. One extra round-trip. |
示例
uip aops project get --project-id 9999dddd-0000-0000-0000-000000000001
uip aops project get --project-id 9999dddd-0000-0000-0000-000000000001 --with-branches
uip aops project get --project-id 9999dddd-0000-0000-0000-000000000001
uip aops project get --project-id 9999dddd-0000-0000-0000-000000000001 --with-branches
数据形状(--输出 json)
{
"Code": "ProjectGet",
"Data": {
"identifier": "9999dddd-0000-0000-0000-000000000001",
"name": "Invoice Processing",
"description": "Daily invoice ingest",
"type": "Process",
"projectVersion": "1.2.0",
"repository": "automation-hub",
"defaultBranch": "main"
}
}
{
"Code": "ProjectGet",
"Data": {
"identifier": "9999dddd-0000-0000-0000-000000000001",
"name": "Invoice Processing",
"description": "Daily invoice ingest",
"type": "Process",
"projectVersion": "1.2.0",
"repository": "automation-hub",
"defaultBranch": "main"
}
}
With --with-branches, Data adds availableBranches: ["main", "release", "feature/x"]. If the project's repository can't be resolved to enumerate branches, availableBranches is an empty array with a warning logged rather than a failure.
uip aops project files
List the file tree of a project at a given reference.
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--project-id <id> | 字符串 | 是 | SC service UUID for the project. |
--path <path> | 字符串 | 否 | Subdirectory to list. Defaults to the project root. |
--reference <ref> | branch/tag/SHA | 否 | Defaults to the default branch's HEAD. |
数据形状(--输出 json)
{ "Code": "ProjectFiles", "Data": [] }
{ "Code": "ProjectFiles", "Data": [] }
One row per entry with its name, path, type, and buildable-unit type.
uip aops project content
Fetch the raw content of one file inside a project.
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--project-id <id> | 字符串 | 是 | SC service UUID for the project. |
--path <path> | 字符串 | 是 | File path relative to the project root. |
--reference <ref> | branch/tag/SHA | 否 | Defaults to the default branch's HEAD. |
数据形状(--输出 json)
{ "Code": "ProjectFileContent", "Data": { "fileContent": "<xaml…>" } }
{ "Code": "ProjectFileContent", "Data": { "fileContent": "<xaml…>" } }
An unresolvable --path/--reference combination fails with Project file '<path>' not found. rather than an empty success.
uip aops project commits
List the commit history for a project. Targeted by --project-id only — there is no location-based (repo/reference) variant of this endpoint.
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--project-id <id> | 字符串 | 是 | SC service UUID for the project. |
--path <path> | 字符串 | 否 | Filter to commits touching this path. |
--branch <name> | 字符串 | 否 | Filter to one branch. Defaults to the default branch. |
--offset <n> | 整数 | 否 | Number to skip. Must be a multiple of --limit. Default 0. |
--limit <n> | 整数 | 否 | Maximum to return. Default 20. |
--search <term> | 字符串 | 否 | Server-side substring filter on commit message. |
数据形状(--输出 json)
{ "Code": "ProjectCommits", "Data": { "result": [] } }
{ "Code": "ProjectCommits", "Data": { "result": [] } }
uip aops project commit
Fetch a single commit by SHA.
选项
| 长 | 值 | 必填 | 描述 |
|---|---|---|---|
--project-id <id> | 字符串 | 是 | SC service UUID for the project. |
--reference <sha> | commit SHA | 是 | Also accepts a branch/tag that resolves to a commit. |
数据形状(--输出 json)
{ "Code": "ProjectCommit", "Data": { "Reference": "0123456789abcdef0123456789abcdef01234567", "Message": "Initial commit" } }
{ "Code": "ProjectCommit", "Data": { "Reference": "0123456789abcdef0123456789abcdef01234567", "Message": "Initial commit" } }
Fails with Commit <reference> not found. if it doesn't resolve.
uip aops solution get
Fetch a Studio solution's metadata by identifier — the persisted solution DTO (name, identifier, source repository, default branch, last-modified info).
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<solution-id> | 是 | Solution identifier from connection solutions <connection-id>. |
数据形状(--输出 json)
{ "Code": "SolutionGet", "Data": { "identifier": "abcd5678-0000-0000-0000-000000000001", "name": "Finance Suite" } }
{ "Code": "SolutionGet", "Data": { "identifier": "abcd5678-0000-0000-0000-000000000001", "name": "Finance Suite" } }
uip aops solution commits
List the commit history for a solution.
参数
| 名称 | 必填 | 用途 |
|---|---|---|
<solution-id> | 是 | Solution identifier from connection solutions <connection-id>. |
选项
| 长 | 值 | 描述 |
|---|---|---|
--path <path> | 字符串 | Filter to commits touching this path. |
--branch <name> | 字符串 | Filter to one branch. Defaults to the default branch. |
--offset <n> | 整数 | Number to skip. Must be a multiple of --limit. Default 0. |
--limit <n> | 整数 | Maximum to return. Default 20. |
--search <term> | 字符串 | Server-side substring filter on commit message. |
数据形状(--输出 json)
{ "Code": "SolutionCommits", "Data": { "result": [] } }
{ "Code": "SolutionCommits", "Data": { "result": [] } }
相关内容
uip aops— overview and concepts.connections— discover project/solution identifiers.pipelines— define and run a CI/CD pipeline against a project.
另请参阅
- 大纲
- uip aops project list
- 选项
- 示例
- 数据形状(--输出 json)
- uip aops project get
- 选项
- 示例
- 数据形状(--输出 json)
- uip aops project files
- 选项
- 数据形状(--输出 json)
- uip aops project content
- 选项
- 数据形状(--输出 json)
- uip aops project commits
- 选项
- 数据形状(--输出 json)
- uip aops project commit
- 选项
- 数据形状(--输出 json)
- uip aops solution get
- 参数
- 数据形状(--输出 json)
- uip aops solution commits
- 参数
- 选项
- 数据形状(--输出 json)
- 相关内容
- 另请参阅