- Overview
- UiPath CLI
- Azure DevOps extension
- Jenkins plugin
CI/CD integrations user guide
Analyzing a project
Prerequisites:
- Create a project.
- Run the CLI
exe(for Windows) ordll(for Linux) file. - Add the required Orchestrator API access application scopes.
To analyze a project, take the following steps:
- Run the
packagetask, usinguipcli package. You can see a list of the available sub-tasks. - Specify the required parameters and run the
analyzesub-task. See the list of parameters below.
Project validation is not performed by the Pack or Analyze tasks of UiPath CLI.
Legend: (*) - Optional, recommended when using additional package feeds.
| Parameter | Description |
|---|---|
|
| Choose what types of messages to output after analyzing:
|
|
| The job fails when any rule is violated. |
|
| Treat warnings as errors. |
|
| The full path to a JSON file where you want to store the results. If you don't add this as an argument, then the results will print only in the standard console. |
|
| A list of rules that you want to ignore during the analysis, separated by commas. |
--orchestratorUsername (*) ( Required if you use Basic Authentication , through a username and a password) | The username used for authenticating to Orchestrator. You must pair it with the corresponding password. |
--orchestratorPassword (*) ( Required if you use Basic Authentication , through a username and a password) | The password used for authenticating to Orchestrator. You must pair it with the corresponding username. |
-orchestratorAuthToken (*) ( Required if you use token-based authentication ) | The OAuth2 refresh token used for authenticating to Orchestrator. You must pair it with the Account Name and Client ID . |
--orchestratorAccountName (*) ( Required if you use token-based authentication ) | The Orchestrator CloudRPA account name. You must pair it with the OAuth2 refresh token and Client ID . |
--orchestratorAccountForApp (*) | The Orchestrator CloudRPA account name(organization name). You must pair it with the Application ID , Application Secret , and Application scope for external application. |
--orchestratorApplicationId (*) ( Required if you use external application authentication ) | The external Application ID. You must pair it with the **Application Account, Application Secret , and Application scope . |
--orchestratorApplicationSecret (*) ( Required if you use external application authentication ) | The external Application Secret. You must pair it with the Application Account , Application ID , and Application scope . |
--orchestratorApplicationScope (*) ( Required if you use external application authentication ) | The list of application scopes, separated by single spaces. You must pair it with the Application Account , Application ID , and Application Secret for external application. |
--orchestratorFolder (*) | The name of the target Orchestrator folder. AccountingTeam\TeamJohn . |
--orchestratorUrl (*) | The URL of the Orchestrator instance. |
--orchestratorTenant (*) | The tenant of the Orchestrator instance where you want to delete a machine. |
-l , --language | The orchestrator language. |
-y , --disableTelemetry | Disable telemetry data. |
|
| Display the trace of the events. |
-identityUrl ( Required for PaaS or MSI deployments) | The URL of your identity server. |
|
| Disable built-in nuget feeds. |
|
| Displays the parameters and examples for this command. |
|
| Display version information. |
Project(s) Path (pos.0) ( Required ) | The path to the project.json file, or the path to the folder that contains multiple project.json files. |
Usage:
package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--saveOutputToFile] [--ignoredRules <activity_1_id,activity_2_id,activity_3_id,activity_4_id>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [--orchestratorUsername <orchestrator_user> --orchestratorPassword <orchestrator_pass>] [--orchestratorAuthToken <auth_token> --orchestratorAccountName <account_name>] [--orchestratorFolder <folder>]package analyze <project_path> [--analyzerTraceLevel <analyzer_trace_level>] [--stopOnRuleViolation] [--treatWarningsAsErrors] [--saveOutputToFile] [--ignoredRules <activity_1_id,activity_2_id,activity_3_id,activity_4_id>] [--orchestratorUrl <orchestrator_url> --orchestratorTenant <orchestrator_tenant>] [--orchestratorUsername <orchestrator_user> --orchestratorPassword <orchestrator_pass>] [--orchestratorAuthToken <auth_token> --orchestratorAccountName <account_name>] [--orchestratorFolder <folder>]Examples:
package analyze "C:\UiPath\Project\project.json"package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error"package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolationpackage analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrorspackage analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json"package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020"package analyze "C:\UiPath\Project\project.json" --analyzerTraceLevel "Error" --stopOnRuleViolation --treatWarningsAsErrors --resultPath "C:\UiPath\Project\output.json" --ignoredRules "ST-NMG-009,ST-DBP-020,UI-USG-011,ST-DBP-020" --orchestratorUrl "https://orchestratorurl.com" --orchestratorTenant "default" --orchestratorUsername "username" --orchestratorPassword "\_ye5zG9(x" --orchestratorAuthToken "AuthToken" --orchestratorAccountName "AccountName" --orchestratorFolder "OrchestratorFolder"
