UiPath Documentation
coding-agents
latest
false
UiPath for Coding Agents user guide
  • Get started
    • Overview
    • Install and set up
    • Choosing your agent
    • Where to run your coding agent
    • Your first build
  • Best practices
  • Capabilities
  • Skills
  • CLI
  • Examples
  • Advanced
  • Help

Install and set up

Install the uip CLI and UiPath skills for your coding agent, then authenticate to your UiPath organization.

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.

Note:

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.

Restricted networks and internal npm registries

UiPath packages are published under the public @uipath scope on npm. The package pages on www.npmjs.com are informational; npm clients and repository proxies retrieve package metadata and archives from https://registry.npmjs.org/.

If your organization restricts npm access:

  • Allow or mirror the complete public @uipath/* scope from https://registry.npmjs.org/.

  • Do not allow only @uipath/cli. The CLI also retrieves @uipath/skills, capability-specific tools, update metadata, and platform-specific supporting packages.

  • If you use an internal npm proxy, configure the @uipath scope to use it. Replace the example URL with your internal registry URL:

    npm config set @uipath:registry https://npm.example.com/
    npm config set @uipath:registry https://npm.example.com/
    

Verify that the CLI and skills packages are available through the configured registry before running the installer:

npm view @uipath/cli version
npm view @uipath/skills version
npm view @uipath/cli version
npm view @uipath/skills version

The supporting package set evolves as capabilities are added. Prefer allowing the @uipath/* scope instead of maintaining an individual package list.

Install

The fastest path is the one-liner installer. It is safe to re-run — every step skips what is already present.

  1. 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
    
  2. Open a new terminal so the updated PATH takes effect, then run uip --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 curl is 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.
Note:

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 -it to choose interactively, or run uip login -t TenantName if you know the name.

Result: the CLI is signed in to your organization and the default tenant is selected.

Verify your setup

  1. Run uip --help to confirm the CLI responds.
  2. 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 variableSkips
--skip-node-SkipNodeUIP_SKIP_NODENode.js install
--skip-skills-SkipSkillsUIP_SKIP_SKILLSuip skills install
--skip-dotnet-SkipDotnetUIP_SKIP_DOTNET.NET SDK
--skip-python-SkipPythonUIP_SKIP_PYTHONPython
--skip-runtimes-SkipRuntimesUIP_SKIP_RUNTIMES.NET SDK + Python
--dry-run-DryRunUIP_DRY_RUNRuns nothing; prints the plan

Once you are set up, continue with Your first build.

  • Prerequisites
  • Restricted networks and internal npm registries
  • Install
  • What the installer does
  • Authenticate
  • Verify your setup
  • Installation options

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated