UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip solution download

Syntax and options for `uip solution download`, which downloads and extracts a Studio Web solution.

uip solution download downloads (exports) a solution from Studio Web as a .uis archive. Pass --extract to also unpack it into a directory.

Synopsis

uip solution download <solution-id> [-d <destination>] [-n <name>] [--extract]
uip solution download <solution-id> [-d <destination>] [-n <name>] [--extract]

Arguments

NameRequiredPurpose
<solution-id>yesStudio Web solution UUID. Find it with uip solution list.

Options

ShortLongValueDefaultDescription
-d--destinationdircurrent dirDestination directory for the downloaded file.
-n--nametextthe solution IDOutput filename, without extension. Existing files are overwritten; --extract uses this name for the extracted directory too. Must be a plain filename — no path separators or ...
--extractflagoffExtract the downloaded .uis archive into a directory, and write AGENTS.md / CLAUDE.md briefing files there if the archive didn't already carry them.

Examples

uip solution download a1b2c3d4-0000-0000-0000-000000000001 \
  --destination ./downloads --extract
uip solution download a1b2c3d4-0000-0000-0000-000000000001 \
  --destination ./downloads --extract

Data shape (--output json)

{
  "Code": "SolutionDownload",
  "Data": {
    "Status": "Solution exported successfully",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Output": "./downloads/a1b2c3d4-0000-0000-0000-000000000001.uis",
    "ExtractedTo": "./downloads/a1b2c3d4-0000-0000-0000-000000000001",
    "BriefingFiles": [
      "./downloads/a1b2c3d4-0000-0000-0000-000000000001/AGENTS.md",
      "./downloads/a1b2c3d4-0000-0000-0000-000000000001/CLAUDE.md"
    ]
  }
}
{
  "Code": "SolutionDownload",
  "Data": {
    "Status": "Solution exported successfully",
    "SolutionId": "a1b2c3d4-0000-0000-0000-000000000001",
    "Output": "./downloads/a1b2c3d4-0000-0000-0000-000000000001.uis",
    "ExtractedTo": "./downloads/a1b2c3d4-0000-0000-0000-000000000001",
    "BriefingFiles": [
      "./downloads/a1b2c3d4-0000-0000-0000-000000000001/AGENTS.md",
      "./downloads/a1b2c3d4-0000-0000-0000-000000000001/CLAUDE.md"
    ]
  }
}

ExtractedTo and BriefingFiles are only present when --extract is passed. BriefingFiles lists only the files this command wrote — if the archive already had AGENTS.md/CLAUDE.md, the field is omitted.

Exit codes

See Exit codes for the shared contract.

See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated