UiPath Documentation
uipath-cli
latest
false

UiPath CLI user guide

Last updated May 7, 2026

uip vss scaffold

uip vss scaffold scaffolds a new vertical solution from the upstream template. It clones UiPath/vertical-solutions-template via git, strips the .git directory, and copies the result into the target directory.

Synopsis

uip vss scaffold [options]
uip vss scaffold [options]

Options

FlagDescription
-t, --target-path <targetPath>Target directory. Created if it does not exist. Defaults to the current working directory.

Prerequisites

git must be installed and on PATH. If git is missing, the command fails with a Failure result pointing at https://git-scm.com/downloads.

Examples

# Scaffold into the current directory
uip vss scaffold

# Scaffold into ./my-app
uip vss scaffold --target-path ./my-app
# Scaffold into the current directory
uip vss scaffold

# Scaffold into ./my-app
uip vss scaffold --target-path ./my-app

Data shape (--output json)

The command emits two success payloads in sequence. First, the clone confirmation:

{
  "Code": "TemplateCloned",
  "Data": {
    "Status": "Template cloned successfully",
    "Path": "./my-app"
  }
}
{
  "Code": "TemplateCloned",
  "Data": {
    "Status": "Template cloned successfully",
    "Path": "./my-app"
  }
}

Followed by next-steps instructions:

{
  "Code": "NextSteps",
  "Data": {
    "Status": "Next steps",
    "Instructions": "cd ./my-app\nbun install\nbun dev"
  }
}
{
  "Code": "NextSteps",
  "Data": {
    "Status": "Next steps",
    "Instructions": "cd ./my-app\nbun install\nbun dev"
  }
}
  • uip vss init — initialize a vss.json in place without cloning the template.
  • uip vss add — register processes once the project is scaffolded.
  • uip vss generate — generate types from the Data Fabric schema bundled with the template.

See also

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated