# UiPath CLI (`uip`) Command Reference > **Quick reference index.** Use `--help` for full option details on any command. **Global flags:** - `--output json` — always use when calling programmatically - `--output-filter ` — JMESPath filter for JSON output - `--profile ` — use a named auth profile from `~/.uipath/profiles//.auth`; `default` keeps the built-in unprofiled login - `--tenant ` — tenant override (defaults to authenticated tenant) - `--verbose` — enable debug logging **List command flags:** - `--limit ` / `--offset ` — pagination. Check `Pagination.HasMore` in output. - `--sort-by ` — sort results (e.g., `Name asc`, `Id desc`) - `--all-fields` — return raw DTO instead of the curated PascalCase projection. Native Orchestrator commands curate by default; the migrated resource commands (assets, queues, buckets, etc.) return the full DTO by default and do not expose this flag. --- ## Installation / bootstrap For fresh macOS/Linux/Windows machines, missing `uip`, or LLM coding-agent setup, use the official onboarding installers. They are idempotent and install Node.js >= 20, `@uipath/cli`, UiPath skills for installed AI coding agents, .NET SDK 8.0, and Python 3.11-3.14. macOS/Linux: ```bash curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash ``` Windows PowerShell: ```powershell irm https://download.uipath.com/uipath-cli/install.ps1 | iex ``` For CI/minimal CLI setup, skip agent skills and runtimes: ```bash curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash -s -- --skip-skills --skip-runtimes ``` ```powershell iwr https://download.uipath.com/uipath-cli/install.ps1 -OutFile install.ps1 ./install.ps1 -SkipSkills -SkipRuntimes ``` --- ## Authentication | Command | Description | |---|---| | `uip login` | Authenticate with UiPath Cloud | | `uip login status` | Show current login status | | `uip login which` | Show which `.auth` file backs the current login | | `uip login tenant list` | List available tenants | | `uip login tenant set ` | Set active tenant | | `uip logout` | End session and clear tokens | Named profiles: - Use `uip login --profile dev`, then pass `--profile dev` on each command that should use that login. - Profile credentials live at `~/.uipath/profiles/dev/.auth`; the built-in default stays at `~/.uipath/.auth`. - Missing profiles do not fall back to the default login or Robot credentials. - Valid profile names use letters, numbers, `.`, `_`, and `-`; `default` is reserved for the built-in login. - Do not combine `--profile ` with auth-command `--file `. --- ## Orchestrator (`uip or`) Manage folders, jobs, processes, machines, users, packages, and more. See [`uipath-orchestrator`](orchestrator/orchestrator.md). | Group | Key Commands | Workflow Guide | |---|---|---| | **Folders** | `list [--all]`, `get`, `create`, `update`, `delete`, `move`, `runtimes` | [Setup Environment](orchestrator/setup-environment.md) | | **Jobs** | `list`, `get`, `start`, `stop`, `restart`, `resume`, `logs [--export]`, `traces`, `healing-data`, `history` | [Run Jobs](orchestrator/run-jobs.md) | | **Processes** | `list`, `get`, `resources`, `version-history`, `create`, `update`, `update-version`, `rollback`, `delete` | [Run Jobs](orchestrator/run-jobs.md) | | **Process ROI** | `get`, `create`, `update`, `delete` | [Business ROI](orchestrator/business-roi.md) | | **Packages** | `list`, `get`, `versions`, `entry-points`, `upload`, `download` | [Run Jobs](orchestrator/run-jobs.md) | | **Machines** | `list`, `get`, `create`, `update`, `delete`, `assign`, `unassign` | [Setup Environment](orchestrator/setup-environment.md) | | **Users** | `list`, `list-in-folder`, `list-available`, `get`, `create`, `update`, `delete`, `current`, `assign`, `unassign`, `assign-roles` | [Setup Environment](orchestrator/setup-environment.md) | | **Roles** | `list`, `permissions`, `get`, `create`, `update`, `delete`, `users list`, `users set`, `user-roles list`, `user-permissions list`, `assign` | [Setup Environment](orchestrator/setup-environment.md) | | **Sessions** | `attended list`, `unattended list`, `machines list `, `list-usernames`, `list-user-executors`, `toggle-debug-mode`, `delete-inactive`, `set-maintenance-mode` | [Manage Sessions](orchestrator/manage-sessions.md) | | **Settings** | `list`, `get`, `update`, `execution`, `timezones` | [Tenant Admin](orchestrator/tenant-admin.md) | | **Calendars** | `list`, `get`, `create`, `update`, `delete` | [Tenant Admin](orchestrator/tenant-admin.md) | | **Licenses** | `list --type`, `toggle`, `info` | [Setup Environment](orchestrator/setup-environment.md) | | **Audit Logs** | `list [--export]` | [Tenant Admin](orchestrator/tenant-admin.md) | | **Credential Stores** | `list`, `get` | [Tenant Admin](orchestrator/tenant-admin.md) | | **Feeds** | `list` | [Tenant Admin](orchestrator/tenant-admin.md) | | **Attachments** | `list --job-key`, `download` | [Tenant Admin](orchestrator/tenant-admin.md) | --- ## Orchestrator resources (`uip or assets` / `queues` / `triggers` / …) Manage assets, queues, triggers, buckets, libraries, and webhooks — a subset of `uip or`. See [Orchestrator resources](orchestrator/resources.md). | Group | Key Commands | Workflow Guide | |---|---|---| | **Assets** | `list`, `get`, `create`, `update`, `delete`, `get-folders`, `share`, `unshare`, `get-asset-value` | [Manage Assets](orchestrator/manage-assets.md) | | **Queues** | `list`, `get`, `create`, `update`, `delete`, `get-folders`, `get-stats`, `share`, `unshare` | [Process Queues](orchestrator/process-queues.md) | | **Queue ROI** | `get`, `create`, `update`, `delete` | [Business ROI](orchestrator/business-roi.md) | | **Queue Items** | `list`, `get`, `add`, `bulk-add`, `update`, `delete`, `delete-bulk`, `get-history`, `get-last-retry`, `has-video`, `set-review-status`, `set-reviewer`, `unset-reviewer`, `get-reviewers` | [Process Queues](orchestrator/process-queues.md) | | **Buckets** | `list`, `get`, `create`, `update`, `delete`, `share`, `unshare`, `list-folders` | [Work with Storage](orchestrator/work-with-storage.md) | | **Bucket Files** | `list`, `list-dirs`, `get`, `download`, `upload`, `delete`, `get-download-url`, `get-upload-url` | [Work with Storage](orchestrator/work-with-storage.md) | | **Triggers** | `list`, `get`, `create`, `update [--enabled\|--disabled]`, `delete`, `history` | [Triggers & Webhooks](orchestrator/triggers-and-webhooks.md) | | **Libraries** | `list`, `get`, `versions`, `upload`, `download`, `delete` | [Resources overview](orchestrator/resources.md) | | **Webhooks** | `list`, `get`, `create`, `update`, `delete`, `ping`, `event-types` | [Triggers & Webhooks](orchestrator/triggers-and-webhooks.md) | --- ## Solution (`uip solution`) `uip solution` (init/new, project add|remove|import, resource list|refresh|get|add|remove|edit, restore, pack, publish, deploy run|status|list|activate|uninstall, deploy config get|set|link|unlink, upload, download, packages list|delete|download) is owned by [`uipath-solution`](/uipath:uipath-solution). Load that skill for any `.uipx` lifecycle work. --- ## Platform Tool (`uip platform`) Manage organization-level licensing — tenant allocations, user/group bundle assignments, and consumables reporting. See [`licensing/licensing.md`](licensing/licensing.md). | Group | Key Commands | Workflow Guide | |---|---|---| | **Tenants Licenses** | `tenants licenses get `, `tenants licenses set --input ` | [Tenant Allocations](licensing/tenant-allocations.md) | | **Users Licenses** | `users licenses available`, `users licenses get `, `users licenses set --input ` | [User & Group Licenses](licensing/user-licenses-allocations.md) | | **Groups Rules** | `groups rules get [--limit --offset --sort-by --sort-order]`, `groups rules details `, `groups rules set --input ` | [User & Group Licenses](licensing/user-licenses-allocations.md) | | **Consumables** | `licenses consumables get --mode {summary\|daily\|folders} [--tenant --unit --start-date --end-date]` | [Consumables Report](licensing/consumables-report.md) | All `uip platform` commands accept `--organization ` to override the org from the current login. --- ## Traces (`uip traces`) LLM execution trace observability and feedback annotation. See [traces/traces.md](traces/traces.md) (spans) and [traces/feedback.md](traces/feedback.md) (feedback). | Command | Description | |---|---| | `uip traces spans get ` | Get spans by trace ID or `--job-key` | | `uip traces feedback create` | Add positive/negative feedback to a trace | | `uip traces feedback get ` | Fetch one feedback record | | `uip traces feedback list` | List feedback, optionally filtered by trace/span/agent/sentiment | | `uip traces feedback list detailed` | Feedback with span context, plus time-range/category/sort filters | | `uip traces feedback update ` | Change sentiment, comment, metadata, or categories | | `uip traces feedback delete ` | Remove feedback | --- ## Other Tool Groups | Group | Command | Description | |---|---|---| | **Integration Service** | `uip is --help` | See [`uipath-integration-service`](integration-service/integration-service.md) | | **Traces** | `uip traces spans get ` | LLM execution trace observability (`--job-key` to scope) | | **RPA** | `uip rpa --help` | RPA workflow management | | **MCP** | `uip mcp serve` | Start Model Context Protocol server | | **Coded Agents** | `uip codedagent --help` | Python agent development | | **Tools** | `uip tools list/search/install` | CLI tool management | --- ## Naming gotchas - Resource sub-nouns are **plural and hyphenated where shown**: `buckets`, `queues`, `assets`, `libraries`, `queue-items`, `bucket-files`. Never singular, never `queueitems`/`bucketfiles`. - The canonical Orchestrator group prefix is `or`; `uip orchestrator` also works as a long-form alias, but these docs use `or`.