- 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 df is the Data Fabric tool: it manages the entity store that backs many UiPath products. The tool lets you browse and mutate entity schemas, work with records (single or batch), query with filters and sorting, import records from CSV, and manage file attachments on record fields. Install it with uip tools install df, or invoke uip df … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation. df is the command prefix; the underlying package is @uipath/data-fabric-tool.
Resources
Each resource has its own reference page. The verb set on each page matches the commands registered by uip df — run uip df --help to confirm the full surface on your installation.
Synopsis
uip df <resource> <verb> [options]
uip df <resource> <verb> [options]
Always uip df, never uip data-fabric. df is the tool's command prefix (see the commandPrefix column in uip tools list).
Common flags
A small set of flags recurs across most resources. They behave the same way wherever they appear:
| Flag | Used by | Purpose |
|---|---|---|
-t, --tenant <tenant-name> | every verb | Override the tenant selected at authentication time. Optional; omit to use the session default. |
-f, --file <path> / --body <json> | mutating verbs (create, update, insert, query, import, upload) | Mutually exclusive ways to supply a JSON body or file path. |
-l, --limit <number> | records list, records query | Page size; defaults to 50. |
--cursor <cursor> | records list, records query | Pagination cursor from a previous response (mutually exclusive with -o, --offset). |
Verb-specific flags are documented on each resource page.
Global options and exit codes
All uip df verbs honor the four global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the shared contract; batch verbs return non-zero when any item fails while still emitting the full success/failure breakdown.
See also
- Concepts: how UiPath CLI is organized — where tools fit in the host + tool model.
- Sessions — how tenant context is resolved.
- Configuration — environment variables and config files that affect every tool.
uip vss— consumes Data Fabric schemas to generate TypeScript types.uip login— session used for all Data Fabric calls.