UiPath Documentation
uipath-cli
latest
false
UiPath CLI user guide

uip vss add

Syntax and options for `uip vss add`, which adds a process or a local Data Fabric entity to the current vertical solution.

uip vss add adds a process or a local Data Fabric entity to the current vertical solution. For process, it rewrites vss.json to include the new entry. For entity, it writes an entity definition into data_fabric_schema.json — it does not touch vss.json. The [target] positional means something different per type: for process it's the project directory to add (defaults to the current directory); for entity it's the entity name (required).

Synopsis​

uip vss add process [target]
uip vss add entity  <target> [options]
uip vss add process [target]
uip vss add entity  <target> [options]
  • <type> — process, entity, or connection.
  • [target] — Project directory (process) or entity name (entity). Defaults to the current directory for process; required for entity.

Options​

FlagDescriptionApplies to
--field <definition>Entity field definition as <name>:<type>. Repeatable.entity
-s, --schema <path>Path to data_fabric_schema.json. Defaults to data_fabric_schema.json in the target directory.entity
-t, --target-path <targetPath>Vertical solution directory. Defaults to the current directory.all types

Examples​

# Add a process from the current directory
uip vss add process

# Add a process from an explicit path
uip vss add process ./processes/onboarding

# Add a local Data Fabric entity with two fields
uip vss add entity Employee --field name:string --field salary:number
# Add a process from the current directory
uip vss add process

# Add a process from an explicit path
uip vss add process ./processes/onboarding

# Add a local Data Fabric entity with two fields
uip vss add entity Employee --field name:string --field salary:number

Data shape (--output json)​

{
  "Code": "ProcessesAdded",
  "Data": {
    "Status": "1 processes added successfully",
    "Path": "/Users/alice/my-app"
  }
}
{
  "Code": "ProcessesAdded",
  "Data": {
    "Status": "1 processes added successfully",
    "Path": "/Users/alice/my-app"
  }
}

For entity, the shape is different:

{
  "Code": "EntityAdded",
  "Data": {
    "Entity": "Employee",
    "Fields": ["name", "salary"],
    "Schema": "/Users/alice/my-app/data_fabric_schema.json"
  }
}
{
  "Code": "EntityAdded",
  "Data": {
    "Entity": "Employee",
    "Fields": ["name", "salary"],
    "Schema": "/Users/alice/my-app/data_fabric_schema.json"
  }
}
Note:

connection is registered as a valid <type> value but always fails with Failure: "Connections are not supported yet" — it is not implemented. Use process or entity.

See also​

  • Synopsis​
  • Options​
  • Examples​
  • Data shape (--output json)​
  • Related​
  • See also​

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated