- Overview
- Get started
- Concepts
- Using UiPath CLI
- How-to guides
- CI/CD recipes
- Command reference
- Overview
- Exit codes
- Global options
- uip codedagent
- uip docsai
- add-test-data-entity
- add-test-data-queue
- add-test-data-variation
- analyze
- build
- create-project
- 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
- restore
- run-file
- search-templates
- start-studio
- stop-execution
- uia
- uip traces
- Migration
- Reference & support
UiPath CLI user guide
uip rpa install-data-fabric-entities applies an add/remove delta to the Data Fabric entity bindings of the active project. Names listed in --add are installed (and any entities they reference are pulled in transitively); names in --remove are dropped. If the resulting selection is empty the project's entity bindings are uninstalled entirely. Entities that no longer exist server-side are silently skipped, and the response reports what is actually installed at the end.
Studio rewrites the project bindings, so the verb requires a Windows runner. Run it after uip rpa list-data-fabric-entities (to know what is available) and before any build or validation step that depends on the generated entity types.
Synopsis
uip rpa install-data-fabric-entities [--add <array>] [--remove <array>] [--service-document <string>] [--namespace <string>]
uip rpa install-data-fabric-entities [--add <array>] [--remove <array>] [--service-document <string>] [--namespace <string>]
Options
| Flag | Description |
|---|---|
--add <array> | Entity names to add to the installed set, e.g. ["Customer", "Invoice"]. Defaults to an empty array. |
--remove <array> | Entity names to remove from the installed set, e.g. ["LegacyOrder"]. Defaults to an empty array. |
--service-document <string> | Optional project-relative service document path. If omitted, the project's default service document is used. |
--namespace <string> | Optional .NET namespace for the generated entity types. If omitted, Studio reuses the previous namespace or derives one from the project name. |
For the complete option list on your installed tool version, run:
uip rpa install-data-fabric-entities --help
uip rpa install-data-fabric-entities --help
Examples
# Add two entities, leave the rest of the binding set alone
uip rpa install-data-fabric-entities \
--add '["Customer", "Invoice"]'
# Swap one entity for another in a single call
uip rpa install-data-fabric-entities \
--add '["NewOrder"]' \
--remove '["LegacyOrder"]' \
--namespace MyOrg.DataFabric
# Add two entities, leave the rest of the binding set alone
uip rpa install-data-fabric-entities \
--add '["Customer", "Invoice"]'
# Swap one entity for another in a single call
uip rpa install-data-fabric-entities \
--add '["NewOrder"]' \
--remove '["LegacyOrder"]' \
--namespace MyOrg.DataFabric
Related
uip rpa list-data-fabric-entities— discover available entity names before installing.