uipath-cli
latest
false
UiPath CLI 用户指南
重要 :
请注意,此内容已使用机器翻译进行了本地化。
新发布内容的本地化可能需要 1-2 周的时间才能完成。
UIP AOPs
管理 UiPath StudioAdmin AOps — 来源控件连接、存储库、自动化项目、解决方案、CI/CD 管道和管道执行 — 使用“uip aops”工具。
uip aops管理StudioAdmin AOps (Automation Ops),即位于源代码控件存储库之上的自动化清单和 CI/CD 层。连接将租户关联到 Git 提供程序(GitHub 或 Azure DevOps); AOps 通过该连接发现存储库、自动化项目和Studio 解决方案;管道定义项目的 CI/CD 构建/运行配置;每次管道运行都会产生一次执行,您可以检查或停止该执行。
这是一个发现 CI/CD 工具,而不是创作工具 — uip aops 永远不会编辑您的项目来源。连接本身通过 Studio 管理员用户界面进行配置;此 CLI 按标识符使用已配置的连接。
该资源跨越四个页面
- 本页— 概念和共享的分页约定。
connections—connection(同步/检查来源控件连接,发现其存储库/项目/解决方案)和repo(检查一个存储库的分支和项目文件)。projects—project(检查一个自动化项目的文件、内容和提交历史记录)solution(适用于 Studio 解决方案)。pipelines—pipeline(CRUD + 运行 CI/CD 管道)和execution(检查/流式传输日志/停止管道运行)。
概念
- 两个后台服务,两个 SDK。
connection、repo、project和solution调用SourceControl (SC) 服务(@uipath/sc-sdk)。pipeline和execution调用CICD 服务(@uipath/cicd-sdk)。它们是独立的标识符命名空间 — 连接 ID 永远不是管道 ID,依此类推。 - 典型流程:
connection list(查找连接)→connection sync --wait(刷新连接)→connection projects <id>/connection repos <id>(发现其中的内容)→pipeline create --file(针对已发现的流程定义 CI/CD 管道)→pipeline run或pipeline save-and-run→execution logs --follow(观看直到结束)。 - 分页约定。每个分页列表动词接受
--offset/--limit(基于页面:--offset必须是--limit的倍数,否则命令会在任何网络调用之前在客户端失败)。默认值因动词而异 — 记录在每个同级页面上。 --login-validity <minutes>适用于所有六个命令组中的每个动词 — 覆盖该一次调用的交互式登录令牌生存期。很少需要。- 破坏性运算需要
-y, --yes。如果没有它,connection delete和pipeline delete都会立即失败 — 此 CLI 从不以交互方式提示。 - 扇出性能降级,但不会完全失败。
project list(跨连接聚合器)并行查询每个可见连接;如果无法读取某些连接,则系统仍会返回可访问的项目,并显示Warning并指明跳过了哪些连接。只有所有连接都失败才是硬错误。
大纲
uip aops connection list
uip aops connection state [--connection <id>]
uip aops connection sync [connection-id] [--wait] [--timeout <ms>] [--poll-interval <ms>]
uip aops connection delete <connection-id> -y
uip aops connection repos <connection-id> [--azure-projects-ids <csv>] [--organization-identifier <name>]
uip aops connection repos-bulk --ids <csv>
uip aops connection projects <connection-id> [--repository-ids <csv>] [--target-framework <name>] [--project-type <type>] [--sort-by <field>] [--sort-order <asc|desc>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops connection solutions <connection-id> [--offset <n>] [--limit <n>] [--search <term>]
uip aops connection azure-projects <connection-id> [--organization-identifier <name>]
uip aops repo branches <repo-id>
uip aops repo project-files <repo-id> [--reference <ref>]
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 pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>
uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]
uip aops connection list
uip aops connection state [--connection <id>]
uip aops connection sync [connection-id] [--wait] [--timeout <ms>] [--poll-interval <ms>]
uip aops connection delete <connection-id> -y
uip aops connection repos <connection-id> [--azure-projects-ids <csv>] [--organization-identifier <name>]
uip aops connection repos-bulk --ids <csv>
uip aops connection projects <connection-id> [--repository-ids <csv>] [--target-framework <name>] [--project-type <type>] [--sort-by <field>] [--sort-order <asc|desc>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops connection solutions <connection-id> [--offset <n>] [--limit <n>] [--search <term>]
uip aops connection azure-projects <connection-id> [--organization-identifier <name>]
uip aops repo branches <repo-id>
uip aops repo project-files <repo-id> [--reference <ref>]
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 pipeline list [--repository-ids <csv>] [--offset <n>] [--limit <n>] [--search <term>]
uip aops pipeline state
uip aops pipeline processes
uip aops pipeline process <process-id>
uip aops pipeline repos
uip aops pipeline get <pipeline-id> [--for-update] [--output-file <path>]
uip aops pipeline search [--name <name> | --prefix <prefix>]
uip aops pipeline create --file <path> [--telemetry-flow-id <id>]
uip aops pipeline update <pipeline-id> --file <path>
uip aops pipeline delete <pipeline-id> -y
uip aops pipeline run <pipeline-id>
uip aops pipeline save-and-run --file <path> [--telemetry-flow-id <id>]
uip aops pipeline executions <pipeline-id> [--offset <n>] [--limit <n>]
uip aops pipeline executions-bulk --ids <csv>
uip aops execution get <execution-id> [--with-arguments]
uip aops execution logs [execution-id] [--job-key <key>] [--follow] [--limit <n>] [--poll-interval <ms>] [--timeout <ms>]
uip aops execution details [execution-id] [--job-key <key>]
uip aops execution stop [execution-id] [--job-key <key>] [--wait] [--poll-interval <ms>] [--timeout <ms>]
相关内容
connections— 来源控件连接和存储库。projects— 自动化项目和 Studio 解决方案。pipelines— CI/CD 管道和执行。