- Get started
- Best practices
- Capabilities
- Skills
- CLI
- Examples
- Examples overview
- Recipe: build an agent
- Recipe: automate with RPA
- Recipe: enter data into a web app
- Recipe: extract data from a desktop app
- Recipe: refactor and test a workflow
- Recipe: a queue-based process with REFramework
- Recipe: build a Maestro Flow
- Recipe: coded app and API workflow
- Recipe: verify a release with Test Manager
- Recipe: extract data from documents with IXP
- Advanced
- Help
This guide takes you from a clean machine to a working setup: the uip CLI, the UiPath skills for your coding agent, and an authenticated connection to your UiPath organization.
Before you let a coding agent act on your UiPath organization, review the recommended guidelines for compliant and responsible use.
Prerequisites
- A UiPath account with access to an organization and tenant.
- A supported coding agent installed: Claude Code, Cursor, Codex CLI, or Google Antigravity.
- Administrator rights on your machine, so the installer can add runtimes.
Install
The fastest path is the one-liner installer. It is safe to re-run — every step skips what is already present.
-
Run the installer for your operating system.
# macOS / Linux curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash# macOS / Linux curl -fsSL https://download.uipath.com/uipath-cli/install.sh | bash# Windows (PowerShell) irm https://download.uipath.com/uipath-cli/install.ps1 | iex# Windows (PowerShell) irm https://download.uipath.com/uipath-cli/install.ps1 | iex -
Open a new terminal so the updated
PATHtakes effect, then runuip --help.
Result: the uip CLI and UiPath skills are installed, and the CLI responds in your terminal.
What the installer does
The script performs six steps in order, and skips any that are already satisfied:
- Ensures
curlis available, used to download the remaining installers. - Ensures Node.js 20 or later is installed.
- Installs the UiPath CLI from npm with
npm install -g @uipath/cli. - Runs
uip skills install, which adds UiPath skills for the coding agents it detects on your machine. - Installs the .NET SDK 8.0.
- Installs Python 3.11 through 3.14.
The CLI is published on the public npm registry, so no token is required to install it.
Authenticate
Log in to UiPath with uip login. Your browser opens and guides you through sign-in.
Adjust the command for your environment and tenant:
- To use an environment other than
cloud.uipath.com, pass an authority:uip login --authority "https://alpha.uipath.com". - To select a tenant, run
uip login -itto choose interactively, or runuip login -t TenantNameif you know the name.
Result: the CLI is signed in to your organization and the default tenant is selected.
Verify your setup
- Run
uip --helpto confirm the CLI responds. - Open your coding agent and ask it a simple UiPath question to confirm the skills are available, for example: "What UiPath skills do you have installed?"
Result: the CLI responds and your coding agent can list the installed UiPath skills.
Installation options
Skip parts you don't want. On macOS/Linux, pass a flag to the script with bash -s -- (or use the matching environment variable); on Windows, use the PowerShell switch.
Flag (.sh) | Switch (.ps1) | Environment variable | Skips |
|---|---|---|---|
--skip-node | -SkipNode | UIP_SKIP_NODE | Node.js install |
--skip-skills | -SkipSkills | UIP_SKIP_SKILLS | uip skills install |
--skip-dotnet | -SkipDotnet | UIP_SKIP_DOTNET | .NET SDK |
--skip-python | -SkipPython | UIP_SKIP_PYTHON | Python |
--skip-runtimes | -SkipRuntimes | UIP_SKIP_RUNTIMES | .NET SDK + Python |
--dry-run | -DryRun | UIP_DRY_RUN | Runs nothing; prints the plan |
Once you are set up, continue with Your first build.