Skip to content

getting_started_cli.md

Latest commit

 

History

History
124 lines (81 loc) · 2.82 KB

getting_started_cli.md

File metadata and controls

124 lines (81 loc) · 2.82 KB

Getting Started

Prerequisites

  • Python 3.10 or higher
  • pip or uv package manager
  • A UiPath Platform account with appropriate permissions

Creating a New Project

We recommend using uv for package management. To create a new project:

mkdir example
cd example
uv init . --python 3.10

This command creates a basic project structure.

Installing the UiPath SDK

Add the UiPath SDK to your project:

uv add uipath

To verify the installation, run:

uv run uipath --version

Authentication

To debug your script locally and publish your project, you need to authenticate with UiPath:

uv run uipath auth

This command opens a new browser window. If you encounter any issues, copy the URL from the terminal and paste it into your browser. After authentication, select your tenant by typing its corresponding number in the terminal.

After completing this step, your project will contain a .env file with your access token, UiPath URL, and other configuration details.

Writing Your Code

Open main.py in your code editor. You can start with this example code:

from dataclasses import dataclass
from typing import Optional


@dataclass
class EchoIn:
    message: str
    repeat: Optional[int] = 1
    prefix: Optional[str] = None


@dataclass
class EchoOut:
    message: str


def main(input: EchoIn) -> EchoOut:
    result = []
    for _ in range(input.repeat or 1):
        line = input.message
        if input.prefix:
            line = f"{input.prefix}: {line}"
        result.append(line)

    return EchoOut(message="\n".join(result))

Initializing the UiPath Project

To create a UiPath project, run the following command in your terminal:

uv run uipath init

Note:: The uipath init command will execute your main.py file to analyze its structure and collect information about inputs and outputs.

This creates a uipath.json file containing the project metadata.

Debugging Your Project

To debug your project, run:

uv run uipath run main.py '{"message": "test"}'

If you see output similar to the following, congratulations! You're almost ready to create your first coded package for UiPath:

[2025-04-11 10:13:58,857][INFO] {'message': 'test'}

Packaging and Publishing

Before packaging your project, add your details to the pyproject.toml file. Add the following line below the description field:

authors = [{ name = "Your name", email = "your.email@uipath.com" }]

Then, package your project:

uv run uipath pack

Finally, publish your package. After selecting your publishing destination (tenant or personal workspace), you'll see details about your package and the success message:

Publishing most recent package: test.0.1.0.nupkg
Package published successfully!