Skip to content

Commit

Permalink
docs: update link to UiPath CLI docs and improve formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
mikael-andersson91 committed Feb 11, 2024
1 parent 6e4fb01 commit f14948b
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
# UiPath CLI Setup Action

A GitHub Action for setting up the [UiPath CLI](https://docs.uipath.com/test-suite/automation-suite/2022.10/user-guide/uipath-command-line-interface) on GitHub Actions runners.

**Note on compatibility:** This action is compatible with both Windows and Ubuntu runners. UiPath offers two separate command line tools for the different operating systems, UiPath.CLI and UiPath.CLI.Windows installed on Ubuntu and Windows respectively. These have different capabilities in terms of project compatibility, noted in the [Compatiblity Matrix sections of this documentation page](https://docs.uipath.com/test-suite/automation-suite/2022.10/user-guide/uipath-command-line-interface#uipathcliwindows-compatibility-matrix)
**Note on compatibility:** This action is compatible with both Windows and Ubuntu runners. UiPath offers two separate command line tools for the different operating systems, UiPath.CLI and UiPath.CLI.Windows installed on Ubuntu and Windows respectively. These have different capabilities in terms of project compatibility, noted in the [Compatiblity Matrix sections of this documentation page](https://docs.uipath.com/test-suite/automation-cloud/latest/user-guide/uipath-command-line-interface#uipathcliwindows-compatibility-matrix)

## How to use

Example usage:

```yml
# Set up the UiPath CLI (uipcli) and add it to PATH on your runner
- name: Setup UiPath (uipcli) command line tool
uses: Mikael-RnD/setup-uipath@v1
```
In further steps of your workflow, you can now use the UiPath CLI (uipcli):
- Packing Studio projects into NuGet packages.
- Deploying NuGet packages to Orchestrator.
- Running jobs in Orchestrator.
- Running Test Sets in Orchestrator.
[See the UiPath documentation for reference on tasks that can be performed with the command line tool](https://docs.uipath.com/test-suite/automation-suite/2022.10/user-guide/executing-tasks-cli)
[See the UiPath documentation for reference on tasks that can be performed with the command line tool](https://docs.uipath.com/test-suite/automation-cloud/latest/user-guide/executing-tasks-cli)
## Inputs
|Name|Description|Required|Example value|
|:--|:--|:--|:--|
|version|Version of the UiPath CLI to retrieve from the [UiPath Official feed](https://uipath.visualstudio.com/Public.Feeds/_artifacts/feed/UiPath-Official/NuGet/UiPath.CLI.Windows/versions/23.10.8753.32995). If not provided, the default version set in action.yml is used|False|23.10.8753.32995|

0 comments on commit f14948b

Please sign in to comment.