📢 uipathcli v2.0 has been released

News Release Notes
1

uipathcli v2.0 has been released with support for analyzing, building and packaging UiPath Studio projects.

uipathcli is Command Line Interface (CLI) for interacting with UiPath Services. It provides a unified command line interface for accessing UiPath resources. You can use the CLI to execute commands in your terminal, either interactively or automated through scripts. The CLI makes it easy to get started using UiPath Service APIs and allows you to configure resources and automate your tasks.

:new: Analyze, Build and Package Studio Projects
v2.0 includes support for analyzing, building and packaging Studio projects, which are generally used as part of a continuous integration pipeline:

uipath studio package analyze --source ./MyProcess
uipath studio package pack --source ./MyProcess --destination ./output

v2.0 - Analyze, Build and Package Studio Projects

:new: Support for Personal Access Tokens
uipathcli supports now Personal Access Tokens (PAT) which allow you to access UiPath services and resources with ease while maintaining a high level of security.

uipathcli provides an interactive wizard which helps you configuring the CLI for the first time and guides you through all supported authentication options:

uipath config

:new: Improved API Discoverability

Access the documentation for supported services, resources and operations either online or as always, through the built-in manuals using the help commands:

uipath --help
uipath orchestrator jobs get --help

Getting Started

Follow the instructions to download the CLI. uipathcli is compatible with all major platforms (Windows, Linux, MacOS) and architectures (x86/x64 and ARM), and requires no installation or additional dependencies.

You can refer to the Quickstart Guide which explains how to use the uipathcli and highlights some of the most common use-cases.

Try it out and let us know what you think. Your feedback, thoughts, or questions are more than appreciated, so please submit them here.

13 Likes
3

Hey team

That’s amazing!
Also like the navigation/drill-down for all Available Services to each command: uipathcli - Documentation

This also answers one of my feature requests on accessing Storage Buckets (https://forum.uipath.com/t/cli-task-put-get-storage-bucket-content/).

Cheers
Roman

3 Likes
5

This looks great! However, I can’t find a good way to configure authentication without going through the interactive configuration triggered by uipath config --auth credentials.

Is there a way to pass the client-id, client-secret and scope directly into the configuration? The use case that immediately comes to mind for me is to setup this CLI in GitHub Actions, configure it directly with provided credentials and then use it for creating queues, triggers and so on in Orchestrator.

Edit: I guess everything I’d want to pass in this way is:

  • Client ID
  • Client Secret
  • Tenant
  • Organization
  • Automation Suite URL (optional)
6

You have three options to set these values as part of your CI pipeline:

  1. Use the uipath config set command to set the values permanently in the configuration file which is applied to all following calls:
uipath config set --key "organization" --value "<your-org>"
uipath config set --key "tenant" --value "<your-tenant>"
uipath config set --key "uri" --value "https://<your-automation-suite-server>"
  1. Use environment variables which also supports credentials like client id, client secret, personal access tokens, etc.:
UIPATH_CLIENT_ID="<your-client-id>"
UIPATH_CLIENT_SECRET="<your-client-secret>"
UIPATH_ORGANIZATION="<your-org>"
UIPATH_UIPATH_TENANT="<your-tenant>"
UIPATH_URI="https://<your-automation-suite-server>"
  1. Use command line arguments to set the values on each individual call:
uipath orchestrator users get --organization "<your-org>" \
                              --tenant "<your-tenant>" \
                              --uri "https://<your-automation-suite-server>"

All supported options are documented here.

1 Like