- 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 is is the Integration Service tool: it manages the connector platform that brokers OAuth connections to external SaaS and runs CRUD activities against them. The tool is organized around five resources — connectors (the catalog), connections (OAuth sessions for an account), activities (per-connector operation definitions), resources (connector objects and their data-plane operations), and triggers (event-driven connector operations). Install it with uip tools install is, or invoke uip is … and let auto-install run. See Tools (plugins) for the install model and uip tools for the command that manages tool installation. is is the command prefix; the underlying package is @uipath/integrationservice-tool.
Most read commands cache responses per-tenant on disk to keep interactive use responsive; pass --refresh on any cached command to force a fresh fetch.
Resources
Each resource has its own reference page. The verb set on each page matches the commands registered by uip is — run uip is --help to confirm the full surface on your installation.
| Resource | Purpose |
|---|---|
| connectors | The connector catalog — every integration the tenant can reach. |
| connections | Tenant-side OAuth credentials/sessions for a connector. |
| activities | The operations a connector exposes (CreateTicket, ListAllRecords, etc.). |
| resources | Connector objects (tickets, contacts, files), with describe and runtime execute. |
| triggers | Event hooks (CREATED, UPDATED, DELETED) the connector can fire. |
Synopsis
uip is <resource> <verb> [options]
uip is <resource> <verb> [options]
Always uip is, never uip integration-service. is is the tool's command prefix (see the commandPrefix column in uip tools list).
Common flags
A small set of flags recurs across the resource verbs. 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. |
--refresh | cached read verbs (list, describe, get, objects) | Force a re-fetch from the API and update the on-disk cache. |
--connection-id <id> | many verbs | Scope a request to one connection. Required by every resources execute verb; optional on metadata reads, where it lets the server include custom objects/fields. |
Verb-specific flags (filters, bodies, query parameters) are documented on each resource page.
Global options and exit codes
All uip is verbs honor the four global options (--output, --output-filter, --log-level, --log-file). Exit codes follow the shared contract.
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 login— session used for all Integration Service calls.