- 概要
- はじめに
- 概念
- Using UiPath CLI
- 使用ガイド
- CI/CD recipes
- コマンド リファレンス
- 概要
- 終了コード
- Global options
- uip codedagent
- uip docsai
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- プロジェクトを作成
- 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
- 元に戻す
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- 移行
- Reference & support
UiPath CLI user guide
uip solution builds, publishes, and deploys solutions — bundles of UiPath projects (RPA workflows, test cases, libraries, agents, Maestro flows, and apps) shipped and versioned as a single artifact. A solution is defined by a .uipx manifest at the root of a solution directory; every project listed in that manifest travels together through pack, publish, and deploy.
Most of your time in this tool is spent on three steps: scaffold or edit a solution locally (new, project), package it into a .zip (pack), and deploy the packaged version to Orchestrator (publish + deploy run). See Your first pipeline for the end-to-end walkthrough.
Verb taxonomy
| Verb family | Operates on | 目的 |
|---|---|---|
new | Local filesystem | Scaffold an empty .uipx solution directory. |
project | ローカル .uipx | Add, import, or remove projects inside the solution manifest. |
resource (via uip solution resource …) | Local solution | List and refresh shared resource declarations (queues, assets, buckets, processes, connections) inside a solution. Do not confuse with uip resource, the Orchestrator resource tool. |
pack | Local solution | Produce a deployable .zip package from a solution directory or .uis file. |
publish | テナント フィード | Upload a packed .zip to the UiPath solution feed. |
upload | Studio Web | Upload a solution for browser-based editing in Studio Web. |
delete | Studio Web | Delete a Studio Web solution by ID. |
packages | テナント フィード | List and delete published solution packages. |
deploy | Orchestrator | Run a deployment, check status, activate, uninstall, and edit deploy configuration files. |
uip solution is provided by the @uipath/solution-tool plugin. If it is not yet installed, uip tools install solution adds it. See Tools (plugins).
Synopsis
uip solution new <solutionName>
uip solution project add <projectPath> [solutionFile]
uip solution project import --source <path> [--solutionFile <path>]
uip solution project remove <projectPath> [solutionFile]
uip solution resource list [solutionPath] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resource refresh [solutionPath]
uip solution pack <solutionPath> <outputPath> [--name <name>] [--version <version>]
uip solution publish <packagePath> [--tenant <tenant-name>]
uip solution upload <solutionPath>
uip solution delete <solution-id>
uip solution packages list [--take <n>] [--order-by <column>] [--order-direction <dir>]
uip solution packages delete <packageName> <packageVersion>
uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--folder-path <path>] [--config-file <path>]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--take <n>]
uip solution deploy uninstall <deployment-name>
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>]
uip solution deploy config set <file> [--all] <args...>
uip solution deploy config link <file> <resource> --name <n> [--folder-path <path>]
uip solution deploy config unlink <file> <resource>
uip solution new <solutionName>
uip solution project add <projectPath> [solutionFile]
uip solution project import --source <path> [--solutionFile <path>]
uip solution project remove <projectPath> [solutionFile]
uip solution resource list [solutionPath] [--kind <kind>] [--search <term>] [--source <all|local|remote>]
uip solution resource refresh [solutionPath]
uip solution pack <solutionPath> <outputPath> [--name <name>] [--version <version>]
uip solution publish <packagePath> [--tenant <tenant-name>]
uip solution upload <solutionPath>
uip solution delete <solution-id>
uip solution packages list [--take <n>] [--order-by <column>] [--order-direction <dir>]
uip solution packages delete <packageName> <packageVersion>
uip solution deploy run --name <n> --package-name <n> --package-version <v> --folder-name <n> [--folder-path <path>] [--config-file <path>]
uip solution deploy status <pipeline-deployment-id>
uip solution deploy activate <deployment-name>
uip solution deploy list [--folder-path <path>] [--take <n>]
uip solution deploy uninstall <deployment-name>
uip solution deploy config get <package-name> [--package-version <v>] [-d <path>]
uip solution deploy config set <file> [--all] <args...>
uip solution deploy config link <file> <resource> --name <n> [--folder-path <path>]
uip solution deploy config unlink <file> <resource>
Every subcommand honours the global options (--output, --output-filter, --log-level, --log-file) and returns the standard exit codes. Default output is JSON.
エンドツーエンドのフロー
┌──────────┐ ┌────────────┐ ┌──────────┐ ┌──────────────┐ ┌──────────────────┐
│ solution │ │ solution │ │ solution │ │ solution │ │ solution deploy │
│ new │ → │ project │ → │ pack │ → │ publish │ → │ run │
│ │ │ add/import │ │ │ │ (tenant feed)│ │ (Orchestrator) │
└──────────┘ └────────────┘ └──────────┘ └──────────────┘ └──────────────────┘
┌──────────┐ ┌────────────┐ ┌──────────┐ ┌──────────────┐ ┌──────────────────┐
│ solution │ │ solution │ │ solution │ │ solution │ │ solution deploy │
│ new │ → │ project │ → │ pack │ → │ publish │ → │ run │
│ │ │ add/import │ │ │ │ (tenant feed)│ │ (Orchestrator) │
└──────────┘ └────────────┘ └──────────┘ └──────────────┘ └──────────────────┘
- Scaffold.
uip solution new my-solutioncreates a directory with an empty.uipxmanifest. - Populate.
uip solution project add ./my-solution/my-project ./my-solution/my-solution.uipxregisters a project subfolder, oruip solution project import --source ./external --solutionFile ./my-solution/my-solution.uipxcopies an external project in. - Pack.
uip solution pack ./my-solution ./dist --version 1.0.0produces./dist/my-solution.1.0.0.zip. - Publish.
uip solution publish ./dist/my-solution.1.0.0.zipuploads the.zipto the tenant solution feed. - Deploy.
uip solution deploy run --name my-deployment --package-name my-solution --package-version 1.0.0 --folder-name MySolution --folder-path Sharedcreates an Orchestrator folder, provisions resources (queues, assets, processes), and activates the solution.
For interactive authoring, substitute step 3 with uip solution upload ./my-solution to open the solution in UiPath Studio Web instead of packing it for deployment.
Each step of this flow is documented on the page linked in the verb taxonomy table above. The full worked example lives in Your first pipeline.
認証
All commands that talk to Orchestrator — publish, upload, delete, packages list, packages delete, and every deploy … subcommand — require an active session. Run uip login once; pass -t, --tenant <tenant-name> on any subcommand to target a specific tenant within your authenticated organization. See Authentication.
Local commands (new, project add/import/remove, pack, resource list/refresh) work offline against files on disk.
参照
- Your first pipeline — hands-on walkthrough of pack → publish → deploy run.
- Tools (plugins) — how the solution tool is distributed and versioned.
- Authentication and Configuration — session setup and per-tenant defaults.
- Global options and Exit codes — contracts shared by every verb.
uip resource— Orchestrator resource CRUD (assets, buckets, queues, libraries, triggers, webhooks). Not to be confused withuip solution resource, which inspects local solution resource declarations.