# uipath(1) — UiPath CLI (uipathcli)

## NAME

`uipath` — Command-line interface for UiPath cloud services (API client)

## SYNOPSIS

```
uipath <service> <operation> [--<argument> <value> ...]
uipath config
uipath autocomplete
```

## DESCRIPTION

`uipathcli` is a Go binary that covers two distinct capability areas:

1. **REST API client** — `orchestrator`, `du`, `identity` subcommands map directly
   to HTTP calls against UiPath cloud services.

2. **Studio operations wrapper** — `studio` subcommands (`package analyze`, `pack`,
   `publish`, `restore`, `test run`) are **not** implemented in the Go binary itself.
   On first use, `uipathcli` downloads a `uipcli` package from GitHub Releases into a
   local modules cache and delegates to it at runtime. For Windows it fetches
   `UiPath.CLI.Windows.24.12.9208.28468.nupkg`; for cross-platform flows it uses
   `UiPath.CLI.24.12.9208.28468.nupkg`. A .NET 8 runtime is also downloaded when needed.
   See `plugin/module_definition.go` and `plugin/module_manager.go` in the source.

**Source:** https://github.com/UiPath/uipathcli
**Latest release:** v2.0.50 (2025-11-19)
**Language:** Go — main binary has no .NET runtime requirement; studio ops fetch .NET runtime on demand.

Binary name: `uipath.exe` (Windows), `uipath` (Linux/macOS)

**Installation (Windows amd64):**
```powershell
Invoke-WebRequest "https://github.com/UiPath/uipathcli/releases/latest/download/uipathcli-windows-amd64.zip" `
  -OutFile "uipathcli.zip"
Expand-Archive -Force -Path "uipathcli.zip" -DestinationPath "."
```

## GLOBAL OPTIONS

| Option | Env var | Description |
|---|---|---|
| `--profile` | `UIPATH_PROFILE` | Config profile (default: `"default"`) |
| `--uri` | `UIPATH_URI` | Server Base-URI |
| `--organization` | `UIPATH_ORGANIZATION` | Organization name |
| `--tenant` | `UIPATH_TENANT` | Tenant name |
| `--output` | `UIPATH_OUTPUT` | Output format: `json` (default) or `text` |
| `--query` | | JMESPath query on output |
| `--wait` | | Wait for JMESPath condition |
| `--wait-timeout` | | Timeout in seconds for `--wait` (default: 30) |
| `--file` | | Read input from file (`-` for stdin) |
| `--identity-uri` | `UIPATH_IDENTITY_URI` | Identity Server URI |
| `--debug` | `UIPATH_DEBUG` | Enable debug output |
| `--insecure` | `UIPATH_INSECURE` | Disable HTTPS certificate check |

---

## SERVICES

### studio

UiPath Studio project operations.

```
uipath studio package analyze  [options]
uipath studio package pack      [options]
uipath studio package publish   [options]
uipath studio package restore   [options]
uipath studio test run          [options]
```

| Subcommand | Description |
|---|---|
| `package analyze` | Static code analysis (Workflow Analyzer) — delegated to downloaded uipcli |
| `package pack` | Pack project into a `.nupkg` — delegated to downloaded uipcli |
| `package publish` | Pack and publish directly to Orchestrator — delegated to downloaded uipcli |
| `package restore` | Restore project dependencies — delegated to downloaded uipcli |
| `test run` | Run workflow tests against a package — delegated to downloaded uipcli |

> **Runtime delegation:** All `studio` subcommands are forwarded to a `uipcli` binary
> that `uipathcli` downloads from GitHub Releases on first use and caches locally.
> The Go binary acts as a launcher and credential broker; the actual Studio work
> is done by the fetched .NET `uipcli`.

```mermaid
sequenceDiagram
    participant U as User
    participant CLI as uipath.exe (Go)
    participant Cache as Module Cache (local)
    participant GH as GitHub Releases
    participant UIPCLI as uipcli.exe (.NET 8)

    U->>CLI: uipath studio package analyze ...

    CLI->>Cache: check for uipcli module
    alt not cached
        CLI->>GH: download UiPath.CLI.Windows.*.nupkg
        GH-->>CLI: .nupkg + .NET 8 runtime
        CLI->>Cache: extract and store
    end

    CLI->>UIPCLI: exec uipcli package analyze ...
    UIPCLI-->>CLI: exit code + output
    CLI-->>U: formatted result
```

---

### orchestrator

Full Orchestrator resource management — 30+ resource types.

```
uipath orchestrator <resource> <operation> [options]
```

Selected resources:

| Resource | Operations |
|---|---|
| `assets` | create, read, update, delete |
| `jobs` | list, start, stop |
| `processes` | list, deploy |
| `machines` | list, create, delete |
| `folders` | list, create |
| `libraries` | list, upload, delete |
| `package-feeds` | manage package feeds |
| `logs` | query execution logs |
| `alerts` | query system alerts |
| `process-schedules` | create/manage triggers |
| `buckets` | storage management |
| `credential-stores` | secure credential management |
| `licenses-runtime` | runtime license management |

---

### du — Document Understanding

```
uipath du digitization  [options]
uipath du classification [options]
uipath du extraction    [options]
uipath du validation    [options]
uipath du discovery     [options]
```

| Subcommand | Description |
|---|---|
| `digitization` | Extract DOM and text from documents |
| `classification` | Sort documents into categories |
| `extraction` | Extract structured data from documents |
| `validation` | Validate extracted data accuracy |
| `discovery` | Discover DU projects and resources |

---

### identity

Identity Server management.

```
uipath identity token           [options]
uipath identity user            [options]
uipath identity group           [options]
uipath identity robot-account   [options]
uipath identity audit-query     [options]
```

---

### config

Interactive configuration — set org, tenant, credentials, and profiles.

```
uipath config
```

---

### autocomplete

Generate shell autocompletion scripts.

```
uipath autocomplete
```

---

## AUTH MODEL

`uipathcli` authenticates against the UiPath Identity Server using
**External App OAuth2** (client credentials grant). Credentials are
stored in a config profile (`uipath config`) and referenced via
`--profile`. Environment variables (`UIPATH_ORGANIZATION`, etc.)
are supported for CI/CD use.

---

## COMPARISON TO uipcli

| Aspect | uipcli | uipathcli |
|---|---|---|
| Runtime | .NET 6/8 | Go binary; fetches .NET 8 + uipcli on first studio use |
| Primary purpose | Build / analyze / deploy | Full API client for all UiPath services |
| Studio ops | pack, analyze, deploy, restore | pack, analyze, publish, restore, test |
| Orchestrator ops | deploy, asset, job run, test | 30+ resource types |
| Document Understanding | — | Full DU pipeline |
| Identity management | — | Users, groups, robot accounts, tokens |
| Auth | External App OAuth2 via CLI flags | External App OAuth2 via config profile |
| NuGet interaction | Yes (pack, analyze, restore) | No |

---

## NOTES

- All credentials can be provided via environment variables for CI/CD pipelines.
- `--query` accepts JMESPath expressions for filtering JSON output.
- `--wait` + `--wait-timeout` allow polling until a condition is met (e.g. job completion).
- `studio` subcommands delegate to a `uipcli` downloaded from GitHub Releases on first use — not embedded in the binary.
- For cross-platform Studio flows: `UiPath.CLI.24.12.9208.28468.nupkg`; for Windows: `UiPath.CLI.Windows.24.12.9208.28468.nupkg`.
- A .NET 8 runtime is also downloaded on demand if not present.

## SEE ALSO

`uipcli`(23.x), `uipcli`(25.x), `UiRobot.exe`(1)

---

© 2026 Christian Prior-Mamulyan — [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) — 2026-04-18