uip solution projects

Syntax and options for `uip solution projects`, which manages the projects listed in a `.uipx` solution manifest, plus cloud-project publish and sync.

uip solution projects manages the projects listed inside a .uipx solution manifest — RPA processes, tests, agents, Maestro flows, case and BPMN projects, coded apps, functions, API workflows, and other buildable project types. A library is not a project — publish it on its own, then attach it with uip solution resources add --source remote --kind Library.

Observação:

This group was previously documented as project (singular). The singular form still works — it's kept registered as a hidden, deprecated alias for back-compat — but projects is canonical going forward.

Subcomando	Finalidade
add	Registre uma pasta do projeto que já está dentro do diretório da solução.
import	Copie uma pasta de projeto externa no diretório da solução e, em seguida, registre-a.
remove	Cancela o registro de um projeto de .uipx (não exclui arquivos no disco).
list	List the projects registered in the local .uipx.
publish	Publish a cloud solution project as a solution package.
resync	Sync or reset a cloud solution project.

add, import, remove, and list operate on local files only — no authentication required. publish and resync operate on a cloud solution project and require an active session.

Resumo

uip solution projects add <project-path> [solutionFile]
uip solution projects import <source> [--solutionFile <path>]
uip solution projects remove <project-path> [solutionFile]
uip solution projects list [--solution-folder <path>]
uip solution projects publish --project-name <name> --package-name <name> --package-version <version> [--folder-name <name>] [--description <text>] [--release-notes <text>] [-t <tenant-name>]
uip solution projects resync [project-name] [--project-name <name>] [--sync-option <Sync|Reset>] [-t <tenant-name>]

Cada subcomando honra as opções globais e retorna os códigos de saída padrão.

Common behaviour (add / import / remove)

• The target project folder must contain a project.uiproj, legacy project.json, or uipath.json descriptor. The command auto-detects which one.
• When [solutionFile] is omitted, the command searches upward from the project path (or the current directory, for import) for the nearest .uipx. If none is found, or if multiple .uipx files live in the same folder, the command fails and exits with 1.
• Um Id (UUID) exclusivo é gerado para cada entrada de projeto adicionada ao manifesto.

---

Adicionar

Registre uma pasta do projeto que já reside dentro do diretório da solução. O caminho relativo da pasta do projeto é registrado em .uipx, e uma entrada correspondente é provisionada no construtor de recursos interno da solução.

Argumentos

• <project-path> (required) — Path to the project folder. Must contain project.uiproj, project.json, or uipath.json.
• [solutionFile] (opcional) — Caminho para o manifesto da solução .uipx . Se omitido, o .uipx mais próximo será localizado percorrendo a partir de <project-path>.

Exemplos

uip solution projects add ./my-solution/my-project ./my-solution/my-solution.uipx

# Auto-detect the .uipx
uip solution projects add ./my-solution/my-project

Formato dos dados (--output json)

{
  "Code": "ProjectAdd",
  "Data": {
    "Status": "Added successfully",
    "Project": "my-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

Modos de falha

• O projeto está fora da pasta da solução. O comando recusa a adição com um ponteiro para projects import, que copia projetos externos.
• Project is already registered. Exits with 1 and a message naming the existing project path.

---

import

Copie uma pasta de projeto externa no diretório da solução (preservando o nome de sua pasta) e, em seguida, registre-a .uipx. Use isso quando o projeto que você deseja incluir já não estiver na raiz da solução.

Argumentos

• <source> (required) — Path to the external project folder to import. Must be a directory containing project.uiproj, project.json, or uipath.json. This is a positional argument, not a flag — earlier docs on this page showed it as --source <path>, which is wrong.

Opções

Long	Valor	Padrão	Description
--solutionFile	Path	nearest .uipx above the current directory	Path to the .uipx solution manifest.

Exemplos

uip solution projects import ./external-project \
  --solutionFile ./my-solution/my-solution.uipx

# From inside the solution directory (auto-detect .uipx)
cd ./my-solution
uip solution projects import ../shared-library

Formato dos dados (--output json)

{
  "Code": "ProjectImport",
  "Data": {
    "Status": "Imported successfully",
    "Project": "external-project/project.uiproj",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

Modos de falha e reversão

• A pasta de destino já existe. O comando recusa-se a substituir; renomeie primeiro a pasta de origem ou remova o destino existente.
• O projeto já está no manifesto .uipx . Recusado antes que quaisquer arquivos sejam copiados.
• A etapa de cópia, gravação ou construtor falha. O comando reverte — o diretório copiado é removido e .uipx é restaurado para seu conteúdo original.

---

remove

Unregister a project from the .uipx solution manifest and remove its entry from the internal resource builder. Files on disk are not deleted. Refuses to remove the last project in a solution (an empty Projects[] is only valid immediately after init) — the one exception is a project of an unsupported type, which can always be removed to unblock pack.

Argumentos

• <project-path> necessário) — Caminho para a pasta do projeto a ser removida. Deve estar registrado no .uipx.
• [solutionFile] (opcional) — Caminho para o manifesto da solução .uipx . O padrão para o .uipx mais próximo encontrado <project-path>.

Exemplos

uip solution projects remove ./my-solution/my-project ./my-solution/my-solution.uipx

Formato dos dados (--output json)

{
  "Code": "ProjectRemove",
  "Data": {
    "Status": "Removed successfully",
    "Project": "my-project",
    "Solution": "/workspace/my-solution/my-solution.uipx"
  }
}

Modos de falha

• O projeto está fora da pasta da solução. O caminho relativo não deve começar com ...
• O projeto não está no manifesto. Sai com 1 e o caminho relativo usado na pesquisa.
• Project is the only one left in the solution. Refused unless it's of an unsupported project type.

---

List

List the projects registered in the local .uipx solution manifest. Reads only on-disk metadata — no backend call.

Opções

Long	Valor	Padrão	Description
--solution-folder	Path	diretório atual	Path to the solution root folder.

Exemplos

uip solution projects list

Formato dos dados (--output json)

{
  "Code": "SolutionProjectsList",
  "Data": [
    {
      "Name": "MyProject",
      "Type": "Process",
      "Id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
      "ProjectRelativePath": "MyProject/project.uiproj",
      "ProjectFilePath": "/workspace/my-solution/MyProject/project.uiproj"
    }
  ]
}

---

Publicar

Publish a cloud solution project (one already living in Automation Cloud, not a local .uipx project) as a solution package, and wait for the publish operation to complete.

Opções

Long	Valor	Padrão	Description
--project-name	text	—	Required. Cloud solution project name to publish.
--package-name	text	—	Required. Solution package name to create.
--package-version	text	—	Required. Solution package version to create.
--folder-name	text	—	Root folder name to store in the solution package.
--description	text	—	Solution package description.
--release-notes	text	—	Solution package release notes.
-t, --tenant	name	padrão da sessão	Tenant.
--timeout	segundos	360	Publish-polling timeout.
--poll-interval	ms	5000	Milliseconds between publish status polls.
--login-validity	minutos	10	Minimum minutes before token expiration to trigger a refresh.

Exemplos

uip solution projects publish --project-name MyProject \
  --package-name my-package --package-version 1.0.0 \
  --folder-name MySolution

Formato dos dados (--output json)

{
  "Code": "SolutionProjectPublish",
  "Data": {
    "ProjectName": "MyProject",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "Status": "Completed"
  }
}

---

resync

Sync or reset a cloud solution project, and wait for the operation to complete. Sync reconciles the project with its source; Reset discards local cloud changes.

Argumentos

• [project-name] (optional) — Cloud solution project name to sync. Can also be provided with --project-name; providing both with different values is an error.

Opções

Long	Valor	Padrão	Description
--project-name	text	—	Cloud solution project name to sync (alternative to the positional argument).
--sync-option	Sync | Reset	Sync	Which sync operation to run.
-t, --tenant	name	padrão da sessão	Tenant.
--timeout	segundos	360	Sync-polling timeout.
--poll-interval	ms	5000	Milliseconds between sync status polls.
--login-validity	minutos	10	Minimum minutes before token expiration to trigger a refresh.

Exemplos

uip solution projects resync --project-name MyProject --sync-option Sync

# Positional form, reset instead of sync
uip solution projects resync MyProject --sync-option Reset

Formato dos dados (--output json)

{
  "Code": "SolutionProjectResync",
  "Data": {
    "ProjectName": "MyProject",
    "Status": "Successful",
    "SyncOption": "Sync",
    "SyncErrors": []
  }
}

On failure, Instructions lists each sync error by service name and affected resource keys.

---

Comandos relacionados

• uip solution init — estruturar a solução antes de adicionar projetos.
• uip solution resources refresh — sincronize novamente recursos após editar as associações do projeto.
• uip solution pack — empacote a solução assim que sua lista de projetos for finalizada.

Veja também

• Seu primeiro pipeline — exemplo de ponta a ponta.
• uip solution visão geral.