UiPath Documentation
uipath-cli
latest
false
Guía del usuario de UiPath CLI
Importante :
Este contenido se ha traducido mediante traducción automática. La localización de contenidos recién publicados puede tardar entre una y dos semanas en estar disponible.

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.

Nota:

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.

SubcomandoPropósito
addRegistra una carpeta de proyecto que ya viva dentro del directorio de la solución.
importCopia una carpeta de proyecto externo en el directorio de la solución y luego regístrala.
removeCancela el registro de un proyecto de .uipx (no elimina archivos en el disco).
listList the projects registered in the local .uipx.
publishPublish a cloud solution project as a solution package.
resyncSync 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.

Sinopsis

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>]
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 respeta las opciones globales y devuelve los códigos de salida estándar.

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.
  • Se genera un Id único (UUID) para cada entrada de proyecto añadida al manifiesto.

Añadir

Registra una carpeta de proyecto que ya resida dentro del directorio de la solución. La ruta relativa de la carpeta del proyecto se .uipx en y se aprovisiona una entrada coincidente en el creador de recursos interno de la solución.

Argumentos

  • <project-path> (required) — Path to the project folder. Must contain project.uiproj, project.json, or uipath.json.
  • (opcional) : ruta al manifiesto .uipx [solutionFile] Si se omite, el .uipx más cercano se encuentra subiendo desde <project-path>.

Ejemplos

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
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

Forma de datos (--json de salida)

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

Modos de fallo

  • El proyecto está fuera de la carpeta de la solución. El comando rechaza la adición con un projects import a, que copia los proyectos externos.
  • Project is already registered. Exits with 1 and a message naming the existing project path.

import

Copia una carpeta de proyecto externo en el directorio de la solución (conservando su nombre de carpeta) y, a continuación, regístrala en .uipx. Utilízalo cuando el proyecto que deseas incluir no esté ya en la raíz de la solución.

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.

Opciones

LargoValorPredeterminadoDescripción
--solutionFileRutanearest .uipx above the current directoryPath to the .uipx solution manifest.

Ejemplos

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
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

Forma de datos (--json de salida)

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

Modos de fallo y reversión

  • La carpeta de destino ya existe. El comando se niega a sobrescribir; cambia el nombre de la carpeta de origen o elimina primero el destino existente.
  • El proyecto ya está en el manifiesto .uipx . Rechazado antes de que se copie cualquier archivo.
  • El paso de copiar, escribir o del creador falla. El comando se revierte: el directorio copiado se elimina y .uipx se restaura a su contenido 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> obligatorio) : ruta a la carpeta del proyecto a eliminar. Debe estar registrado actualmente en .uipx.
  • (opcional) : ruta al manifiesto .uipx [solutionFile] El valor predeterminado es el .uipx más cercano encontrado al subir desde <project-path>.

Ejemplos

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

Forma de datos (--json de salida)

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

Modos de fallo

  • El proyecto está fuera de la carpeta de la solución. La ruta relativa no debe comenzar con ...
  • El proyecto no está en el manifiesto. Sale con 1 y la ruta relativa utilizada para buscar.
  • Project is the only one left in the solution. Refused unless it's of an unsupported project type.

Lista

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

Opciones

LargoValorPredeterminadoDescripción
--solution-folderRutadirectorio actualPath to the solution root folder.

Ejemplos

uip solution projects list
uip solution projects list

Forma de datos (--json de salida)

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

Opciones

LargoValorPredeterminadoDescripción
--project-nametextRequired. Cloud solution project name to publish.
--package-nametextRequired. Solution package name to create.
--package-versiontextRequired. Solution package version to create.
--folder-nametextRoot folder name to store in the solution package.
--descriptiontextSolution package description.
--release-notestextSolution package release notes.
-t, --tenantnamesesión predeterminadaTenant.
--timeoutsegundos360Publish-polling timeout.
--poll-intervalms5000Milliseconds between publish status polls.
--login-validityminutos10Minimum minutes before token expiration to trigger a refresh.

Ejemplos

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

Forma de datos (--json de salida)

{
  "Code": "SolutionProjectPublish",
  "Data": {
    "ProjectName": "MyProject",
    "PackageName": "my-package",
    "PackageVersion": "1.0.0",
    "Status": "Completed"
  }
}
{
  "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.

Opciones

LargoValorPredeterminadoDescripción
--project-nametextCloud solution project name to sync (alternative to the positional argument).
--sync-optionSync | ResetSyncWhich sync operation to run.
-t, --tenantnamesesión predeterminadaTenant.
--timeoutsegundos360Sync-polling timeout.
--poll-intervalms5000Milliseconds between sync status polls.
--login-validityminutos10Minimum minutes before token expiration to trigger a refresh.

Ejemplos

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

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

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

Forma de datos (--json de salida)

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

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


Ver también

¿Te ha resultado útil esta página?

Conectar

¿Necesita ayuda? Soporte

¿Quiere aprender? UiPath Academy

¿Tiene alguna pregunta? Foro de UiPath

Manténgase actualizado