- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip coder
- uip context-grounding
- uip docsai
- uip function
- uip guardrails
- uip llm-configuration
- uip llm-gateway
- uip maestro authoring
- uip maestro registry
- uip model-hub
- activities find
- activities get-default-xaml
- analyze
- analyzer-rules list
- build
- cleanup
- data-fabric-entities install
- data-fabric-entities list
- files diff
- get-library-object-repository
- get-object-repository
- init
- instances list
- pack
- packages inspect
- packages install
- packages versions
- publish
- remote
- restore
- run, debug & execution
- settings
- studio start
- templates search
- test-data add-entity
- test-data add-queue
- test-data add-variation
- tm
- uia
- validate
- workflow-examples get
- workflow-examples list
- uip tasks
- uip traces
- uip traces feedback
- Migration
- Reference & support
uip vss generate
Syntax and options for `uip vss generate`, which produces a TypeScript file from a Data Fabric schema for use in vertical solution code.
uip vss generate produces a TypeScript vss.gen.ts file from a Data Fabric schema (data_fabric_schema.json) or a vss.json config. It resolves choice sets into TypeScript unions and emits entity types the solution code can import. Run it after editing the entity schema or pulling a new schema export from uip df.
Synopsis
uip vss generate [options]
uip vss generate [options]
Options
| Flag | Description |
|---|---|
-s, --schema <path> | Path to a schema file — either data_fabric_schema.json or vss.json. The source is inferred from the filename. When omitted, resolution falls back to the order below. |
-t, --target-path <targetPath> | Directory to resolve the default schema path from, and to write vss.gen.ts into. Defaults to the current directory. |
When --schema is omitted, resolution checks, in order: <target-path>/data_fabric_schema.json, then <target-path>/vss.json, then <target-path>/client/data_fabric_schema.json, then <target-path>/client/vss.json (the client/ subdirectory is where a scaffolded app's schema typically lives). If none of the four exist, the command fails and lists all four checked paths.
Examples
# Generate using the schema at <target>/data_fabric_schema.json
uip vss generate
# Custom schema path and target directory
uip vss generate \
--schema ./schemas/data_fabric_schema.json \
--target-path ./src/generated
# Generate using the schema at <target>/data_fabric_schema.json
uip vss generate
# Custom schema path and target directory
uip vss generate \
--schema ./schemas/data_fabric_schema.json \
--target-path ./src/generated
Data shape (--output json)
{
"Code": "TypesGenerated",
"Data": {
"Path": "/Users/alice/my-app/vss.gen.ts"
}
}
{
"Code": "TypesGenerated",
"Data": {
"Path": "/Users/alice/my-app/vss.gen.ts"
}
}
Related
- uip df entities — author and inspect the schema that
generateconsumes. - uip vss init — produce the
vss.jsonthatgeneratecan read as a schema source.