- Vue d'ensemble (Overview)
- Démarrer
- Concepts
- Using UiPath CLI
- Guides pratiques
- CI/CD recipes
- Référence de commande
- Vue d'ensemble (Overview)
- Codes de sortie
- Global options
- uip codedagent
- uip docsai
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- créer-projet
- diff
- find-activities
- get-analyzer-rules
- get-default-activity-xaml
- get-errors
- get-manual-test-cases
- get-manual-test-steps
- get-versions
- get-workflow-example
- indicate-application
- indicate-element
- inspect-package
- install-data-fabric-entities
- install-or-update-packages
- list-data-fabric-entities
- list-workflow-examples
- pack
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migration
- Reference & support
UiPath CLI user guide
uip solution project manages the projects listed inside a .uipx solution manifest — workflows, test cases, libraries, agents, Maestro flows, and apps. Three subcommands are available:
All three subcommands operate on local files only; no authentication is required.
Synopsis
uip solution project add <projectPath> [solutionFile]
uip solution project import --source <path> [--solutionFile <path>]
uip solution project remove <projectPath> [solutionFile]
uip solution project add <projectPath> [solutionFile]
uip solution project import --source <path> [--solutionFile <path>]
uip solution project remove <projectPath> [solutionFile]
Each subcommand honours the global options and returns the standard exit codes.
Common behaviour
- The target project folder must contain either a
project.uiprojor a legacyproject.jsondescriptor. The command auto-detects which one. - When
<solutionFile>is omitted, the command searches upward from the project path (or the current directory, forimport) for the nearest.uipx. If none is found, or if multiple.uipxfiles live in the same folder, the command fails with a descriptive error and exits with1. - A unique
Id(UUID) is generated for each project entry added to the manifest.
uip solution project add
Register a project folder that already resides inside the solution directory. The project folder's relative path is recorded in .uipx, and a matching entry is provisioned in the solution's internal resource builder.
Arguments
<projectPath>(required) — Path to the project folder. Must containproject.uiprojorproject.json.[solutionFile](optional) — Path to the.uipxsolution manifest. If omitted, the nearest.uipxis located by walking up from<projectPath>.
Options
None beyond the global options.
Exemples
Minimal
uip solution project add ./my-solution/my-project ./my-solution/my-solution.uipx
uip solution project add ./my-solution/my-project ./my-solution/my-solution.uipx
Auto-detect the .uipx
uip solution project add ./my-solution/my-project
uip solution project add ./my-solution/my-project
Scripting — add, then pack in one pipeline
uip solution project add ./my-solution/my-project
uip solution pack ./my-solution ./dist --version 1.0.0
uip solution project add ./my-solution/my-project
uip solution pack ./my-solution ./dist --version 1.0.0
Data shape (--output json)
{
"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"
}
}
Failure modes
- Project is outside the solution folder. The command refuses the add with a pointer to
project import, which copies external projects in. - Project is already registered. Exits with
1and a message naming the existingProjectRelativePath.
uip solution project import
Copy an external project folder into the solution directory (preserving its folder name), then register it in the .uipx. Use this when the project you want to include is not already under the solution root.
Options
--source <path>(required) — Path to the external project folder to import. Must be a directory containingproject.uiprojorproject.json.--solutionFile <path>(optional) — Path to the.uipxsolution manifest. Defaults to the nearest.uipxfound by walking up from the current working directory.
Exemples
Commun
uip solution project import \
--source ./external-project \
--solutionFile ./my-solution/my-solution.uipx
uip solution project import \
--source ./external-project \
--solutionFile ./my-solution/my-solution.uipx
From inside the solution directory (auto-detect .uipx)
cd ./my-solution
uip solution project import --source ../shared-library
cd ./my-solution
uip solution project import --source ../shared-library
Data shape (--output json)
{
"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"
}
}
Failure modes and rollback
- Destination folder already exists. The command refuses to overwrite; rename the source folder or remove the existing destination first.
- Project already in the
.uipxmanifest. Refused before any files are copied. - Copy, write, or builder step fails. The command rolls back — the copied directory is removed and the
.uipxis restored to its original content.
uip solution project remove
Unregister a project from the .uipx solution manifest and drop its entry from the internal resource builder. Files on disk are not deleted.
Arguments
<projectPath>(required) — Path to the project folder to remove. Must currently be registered in the.uipx.[solutionFile](optional) — Path to the.uipxsolution manifest. Defaults to the nearest.uipxfound by walking up from<projectPath>.
Exemples
Minimal
uip solution project remove ./my-solution/my-project ./my-solution/my-solution.uipx
uip solution project remove ./my-solution/my-project ./my-solution/my-solution.uipx
Scripting — remove multiple projects
for p in project-a project-b project-c; do
uip solution project remove "./my-solution/$p" || true
done
for p in project-a project-b project-c; do
uip solution project remove "./my-solution/$p" || true
done
Data shape (--output json)
{
"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"
}
}
Failure modes
- Project is outside the solution folder. The relative path must not start with
... - Project is not in the manifest. Exits with
1and the relative path used to search.
Related commands
uip solution new— scaffold the solution before adding projects.uip solution resource refresh— re-sync resources after editing project bindings.uip solution pack— package the solution once its project list is finalized.
Voir également
- Your first pipeline — end-to-end example.
uip solutionoverview.
- Synopsis
- Common behaviour
- uip solution project add
- Arguments
- Options
- Exemples
- Data shape (--output json)
- Failure modes
- uip solution project import
- Options
- Exemples
- Data shape (--output json)
- Failure modes and rollback
- uip solution project remove
- Arguments
- Exemples
- Data shape (--output json)
- Failure modes
- Related commands
- Voir également