UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

uip aops connections

Syntax and options for `uip aops connection` and `uip aops repo`, which sync SourceControl connections and inspect the repositories discovered through them.

uip aops connection manages SourceControl connections — the per-tenant link to a Git provider (GitHub or Azure DevOps) that StudioAdmin uses to discover repositories, automation projects, and solutions. uip aops repo inspects a single repository's branches and automation-project files once you have a repository identifier from connection repos. See the uip aops overview for shared concepts and the SC-service/CICD-service split.

Observação:

Connection creation is performed via the StudioAdmin UI — this CLI only consumes already-provisioned connections by identifier. Use connection list to discover identifiers, then connection sync --wait to refresh one.

Resumo

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>] [--azure-projects-ids <csv>] [--organization-identifier <name>] [--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 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>] [--azure-projects-ids <csv>] [--organization-identifier <name>] [--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 connection list

List every SourceControl connection visible to the current user.

Formato dos dados (--output json)

{
  "Code": "ConnectionList",
  "Data": [
    { "identifier": "f1e2d3c4-0000-0000-0000-000000000001", "name": "GitHub - main org", "type": "GitHub" }
  ]
}
{
  "Code": "ConnectionList",
  "Data": [
    { "identifier": "f1e2d3c4-0000-0000-0000-000000000001", "name": "GitHub - main org", "type": "GitHub" }
  ]
}

Use the returned identifier with every other connection, repo, and project command.

uip aops connection state

Fetch the current sync state for connections.

Opções

LongValorDescription
--connection <id>StringFilter to a single connection identifier. Client-side filter — the API returns every connection's state and the CLI filters locally.

Formato dos dados (--output json)

{
  "Code": "ConnectionState",
  "Data": [
    { "identifier": "f1e2d3c4-0000-0000-0000-000000000001", "syncState": "Success", "syncingInProgress": false }
  ]
}
{
  "Code": "ConnectionState",
  "Data": [
    { "identifier": "f1e2d3c4-0000-0000-0000-000000000001", "syncState": "Success", "syncingInProgress": false }
  ]
}

syncState is Success, Fail, or Broken.

uip aops connection sync

Trigger a sync for one connection, or every connection in the org if [connection-id] is omitted.

Argumentos

NameRequiredFinalidade
[connection-id]nãoConnection identifier from connection list. Omit to sync every connection in the org.

Opções

LongValorDescription
--waitBandeiraPoll the state endpoint until the sync reaches a terminal state instead of returning immediately.
--timeout <ms>Número inteiroMaximum time to wait when --wait is set. Default 300000 (5 minutes).
--poll-interval <ms>Número inteiroInterval between state polls. Default 2000.

The trigger endpoint returns 202 immediately; without --wait, control returns as soon as the sync is queued (Code: "ConnectionSyncStarted"). With --wait, a non-success terminal state (e.g. Broken) is reported as a failure, not success.

Exemplo

uip aops connection sync f1e2d3c4-0000-0000-0000-000000000001 --wait
uip aops connection sync f1e2d3c4-0000-0000-0000-000000000001 --wait

Formato dos dados (--output json)

{ "Code": "ConnectionSynced", "Data": { "identifier": "f1e2d3c4-0000-0000-0000-000000000001", "syncState": "Success", "syncingInProgress": false } }
{ "Code": "ConnectionSynced", "Data": { "identifier": "f1e2d3c4-0000-0000-0000-000000000001", "syncState": "Success", "syncingInProgress": false } }

Syncing every connection (no connection-id) returns an array under Data instead of one object.

uip aops connection delete

Delete a SourceControl connection by identifier. Permanent — projects and solutions discovered through this connection are no longer reachable.

Argumentos

NameRequiredFinalidade
<connection-id>simConnection identifier from connection list.

Opções

LongDescription
-y, --yesRequired. Confirms this irreversible operation — the CLI never prompts.

Formato dos dados (--output json)

{ "Code": "ConnectionDeleted", "Data": { "ConnectionId": "f1e2d3c4-0000-0000-0000-000000000001" } }
{ "Code": "ConnectionDeleted", "Data": { "ConnectionId": "f1e2d3c4-0000-0000-0000-000000000001" } }

uip aops connection repos

List repositories visible through a single connection.

Argumentos

NameRequiredFinalidade
<connection-id>simConnection identifier from connection list.

Opções

LongValorDescription
--azure-projects-ids <csv>comma-separatedNarrow to specific Azure DevOps project identifiers. Azure connections only.
--organization-identifier <name>StringScope to one Azure DevOps organization. Azure connections only, for cross-organization connections.

Formato dos dados (--output json)

{ "Code": "ConnectionRepos", "Data": [ { "identifier": "abcd1234-0000-0000-0000-000000000001", "name": "automation-hub" } ] }
{ "Code": "ConnectionRepos", "Data": [ { "identifier": "abcd1234-0000-0000-0000-000000000001", "name": "automation-hub" } ] }

uip aops connection repos-bulk

Fetch repositories for multiple connections in a single round-trip.

Opções

LongValorRequiredDescription
--ids <csv>comma-separatedsimConnection identifiers from connection list.

Formato dos dados (--output json)

{
  "Code": "ConnectionReposBulk",
  "Data": [
    { "ConnectionId": "f1e2d3c4-0000-0000-0000-000000000001", "Repositories": [ { "identifier": "abcd1234-0000-0000-0000-000000000001", "name": "automation-hub" } ] }
  ]
}
{
  "Code": "ConnectionReposBulk",
  "Data": [
    { "ConnectionId": "f1e2d3c4-0000-0000-0000-000000000001", "Repositories": [ { "identifier": "abcd1234-0000-0000-0000-000000000001", "name": "automation-hub" } ] }
  ]
}

One row per connection — ConnectionId is kept as a plain value (not a normalized key) so it survives output formatting and feeds back into connection repos <id>.

uip aops connection projects

List automation projects discovered through a connection.

Argumentos

NameRequiredFinalidade
<connection-id>simConnection identifier from connection list.

Opções

LongValorDescription
--repository-ids <csv>comma-separatedNarrow to specific repository identifiers from connection repos.
--target-framework <name>StringServer-side filter on project target framework.
--project-type <type>StringServer-side filter on project type (e.g. Process, Library, Agent).
--azure-projects-ids <csv>comma-separatedAzure connections only.
--organization-identifier <name>StringAzure connections only.
--sort-by <field>StringField to sort by (e.g. name, lastModifiedDate).
--sort-order <asc|desc>ENUMSort direction. Combine with --sort-by.
--offset <n>Número inteiroNumber to skip. Must be a multiple of --limit. Default 0.
--limit <n>Número inteiroMaximum to return. Default 10.
--search <term>StringServer-side substring filter on project name.

Exemplos

uip aops connection projects f1e2d3c4-0000-0000-0000-000000000001

uip aops connection projects f1e2d3c4-0000-0000-0000-000000000001 \
  --repository-ids abcd1234-0000-0000-0000-000000000001 --sort-by name --sort-order asc
uip aops connection projects f1e2d3c4-0000-0000-0000-000000000001

uip aops connection projects f1e2d3c4-0000-0000-0000-000000000001 \
  --repository-ids abcd1234-0000-0000-0000-000000000001 --sort-by name --sort-order asc

Formato dos dados (--output json)

{
  "Code": "ConnectionProjects",
  "Data": [
    { "ProjectId": "9999dddd-0000-0000-0000-000000000001", "Name": "Invoice Processing", "Description": "Daily invoice ingest", "Type": "Process", "Repository": "automation-hub" }
  ]
}
{
  "Code": "ConnectionProjects",
  "Data": [
    { "ProjectId": "9999dddd-0000-0000-0000-000000000001", "Name": "Invoice Processing", "Description": "Daily invoice ingest", "Type": "Process", "Repository": "automation-hub" }
  ]
}

uip aops connection solutions

List Studio solutions discovered through a connection.

Argumentos

NameRequiredFinalidade
<connection-id>simConnection identifier from connection list.

Opções

LongValorDescription
--offset <n>Número inteiroNumber to skip. Must be a multiple of --limit. Default 0.
--limit <n>Número inteiroMaximum to return. Default 20.
--search <term>StringServer-side substring filter on solution name.

Formato dos dados (--output json)

{ "Code": "ConnectionSolutions", "Data": { "result": [] } }
{ "Code": "ConnectionSolutions", "Data": { "result": [] } }

uip aops connection azure-projects

List Azure DevOps projects reachable through an Azure connection. GitHub connections always return an empty list.

Argumentos

NameRequiredFinalidade
<connection-id>simAzure connection identifier from connection list.

Opções

LongValorDescription
--organization-identifier <name>StringScope to one Azure DevOps organization, for connections spanning multiple.

Formato dos dados (--output json)

{ "Code": "ConnectionAzureProjects", "Data": [] }
{ "Code": "ConnectionAzureProjects", "Data": [] }

uip aops repo

Inspect a repository already surfaced via connection repos <connection-id>.

uip aops repo branches

List branches for a repository.

Argumentos
NameRequiredFinalidade
<repo-id>simRepository identifier from connection repos <connection-id>.
Formato dos dados (--output json)
{ "Code": "RepoBranches", "Data": [ { "Name": "main", "Main": true }, { "Name": "release", "Main": false } ] }
{ "Code": "RepoBranches", "Data": [ { "Name": "main", "Main": true }, { "Name": "release", "Main": false } ] }

Use the branch Name as --reference on repo project-files, project content, etc.

uip aops repo project-files

List automation project files (project.json roots) in the repository at a given reference.

Argumentos
NameRequiredFinalidade
<repo-id>simRepository identifier from connection repos <connection-id>.
Opções
LongValorDescription
--reference <ref>branch/tag/SHADefaults to the default branch's HEAD.
Formato dos dados (--output json)
{ "Code": "RepoProjectFiles", "Data": [] }
{ "Code": "RepoProjectFiles", "Data": [] }
  • uip aops — overview and concepts.
  • projects — inspect a project or solution once discovered here.
  • pipelines — define and run CI/CD pipelines against a discovered project.

Veja também

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades