UiPath Documentation
getting-started
latest
false
Getting started developer guide
  • Overview
    • Overview
  • Getting Started with UiPath Agents
    • Introduction
    • Set up your environment
    • Build the agent
    • Test the agent
  • Getting Started with UiPath Agents using LangGraph
  • Building a Low-Code Agent in Studio Web
  • Adding Tools to Your UiPath Agent

Set up your environment

Install the UiPath CLI, set up your project structure, and configure your coding agent with UiPath skills.

Step 1 - Install the UiPath CLI and agent tool

The UiPath CLI (uip) is a cross-platform tool for UiPath authentication, project scaffolding, and deployment. It uses a plugin system: the base CLI handles auth, and you install tools for the project types you build.

  1. Install the base CLI globally:

    npm install -g @uipath/cli
    npm install -g @uipath/cli
    
  2. Verify the installation:

    uip --version
    uip --version
    

    You should see 1.1.0 or later.

  3. Install the agent tool, which adds the uip agent command group used throughout this lab:

    uip tools install agent-tool
    uip tools install agent-tool
    
  4. Confirm it installed:

    uip tools list
    uip tools list
    

    You should see agent-tool in the output.


Step 2 - Install UiPath skills for your coding agent (optional)

If you are using a coding agent (Claude Code, Cursor, Copilot, Gemini, or Codex) alongside the CLI, installing the UiPath skills gives it knowledge of agent project structure, CLI commands, and best practices. Every command in this lab is spelled out explicitly; skipping this step does not affect the walkthrough, but skills make it faster to troubleshoot or extend the agent afterward.

uip skills install --agent claude
uip skills install --agent claude

Replace claude with your agent if you are using a different one: cursor, copilot, gemini, or codex.

Skills install globally to your home directory (for example, ~/.claude/skills/ for Claude Code) and are available in every project from this point forward.


Step 3 - Authenticate to UiPath

  1. Authenticate the CLI to your UiPath account:

    uip login
    uip login
    

    This opens a browser window where you sign in and select your tenant. Once complete, the terminal confirms you are logged in.

  2. Verify your login status:

    uip login status
    uip login status
    

    You should see "Status": "Logged in" along with your organization and tenant name.


With the CLI installed and your UiPath account connected, you are ready to scaffold the agent in the next section.

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated