UiPath Studio

Argument Descriptions for the UiPath.DiagTool Utility

To use the tool launch an elevated instance of the Command Prompt and navigate to the tool location by using the cd C:\Program Files (x86)\UiPath\Studio command. You can use it with the following arguments:

Argument
Description

-providers=[Value]

Retrieves info about the specified provider(s). Here, [Value] represents one or more comma-separated providers. Please check the available providers table below to learn more.
Examples:

  • -providers=all - Retrieves info about all providers.
  • -providers=screen,computer,procs --procs.extra=UiPath.Service.Host - Retrieves info about the UiPath.Service.Host process, the screen information (setup, resolution), and general OS and computer ID information.

-file=File_Path\Logs.zip

The path of the Logs.zip file which contains all requested info from providers. If only a file name is provided, the file is saved on the desktop.
Example:

  • -file=C:\WorkLogs\ProcsAndSettings.zip - Creates the ProcsAndSettings.zip file in the C:\WorkLogs folder, containing all your requested logs.
    This command can also be used with -cwd. However, the -file command only needs to contain the name of the .zip file.
    Example:
  • -file=ProcsAndSettings.zip -cwd - Creates the ProcsAndSettings.zip file in the Studio installation folder.

-console

Displays the full report in the console instead of a summary.

-cwd

Used along with the -file=ReportFiles.zip command to create the .zip file to the Studio installation folder instead of a custom path.

-q, -quiet

Silently retrieves requested logs, with minimal console output.

-h, -help

Displays the list of supported commands.

Available Providers

Provider Name
Command
Retrieved Information

UiPath Installations

-providers=installs

Retrieves info about UiPath product installations, such as installed Studio version, Studio and Robot installation paths, and License information.

Computer Information

-providers=computer

Retrieves general OS and computer ID information, such as computer name, domain, OS type and version, and user global proxy.

UiPath Processes

-providers=procs
--procs.extra=RunningProcess

Retrieves information about UiPath running processes, such as Robot Service, Agent, and Executor diagnostics and resource impact.
Examples:
-providers=procs - Retrieves info about all running UiPath processes, such as path, arguments, user, session, platform, resource consumption.-providers=procs --procs.extra=UiPath.Service.Host - Retrieves info only about the UiPath.Service.Host process, such as path, arguments, user, session, platform, resource consumption.

Settings Files

-providers=settings
--settings.timeout=ValueInMs

Retrieves information such as Studio and Robot settings files, NuGet user configs, or the status of the connection between Orchestrator and the Robot. The connection is checked using a specific timeout value. By default, if the -providers=settings command is used alone, the timeout value is set to 4000 milliseconds.
Examples:
-providers=settings - Retrieves info with the default timeout value.
-providers=settings --settings.timeout=30000 - Retrieves info with the timeout value of 30000 milliseconds.

Terminal Sessions

-providers=sessions

Retrieves info about running Terminal Server sessions.

Screen Information

-providers=screen

Retrieves screen information, such as setup and resolution, for the displays in use.

Third Party Installations

-providers=other

Retrieves information about third party product installations, such as web browsers, .NET Framework, antivirus software, Visual C++ Redistributable, or Adobe Acrobat Reader.

Environment Variable

-providers=envvars

Retrieves the name, associated user, and value of environment variables pertaining to UiPath.

Log Files

-providers=logs
--logs.exec_cnt=Value
--logs.studio_cnt=Value
--logs.etl_cnt=Value

Retrieves log files related to the Robot Executor, Studio, and .etl files. By default, only the last 10 Robot Executor logs, 10 Studio logs, and the latest .etl file are retrieved from the desktop if you use the -providers=logs command alone.
Examples:
-providers=logs - Retrieves the default number of log files for Robot Executor, Studio, and the latest .etl file from the desktop.
You can also specify the exact number of logs to retrieve:
-providers=logs --logs.exec_cnt=50 --logs.studio_cnt=30 --logs.etl_cnt=3 - Retrieves the last 50 Robot Executor logs, 30 Studio logs, and 3 .etl files from the desktop.

Event Logs

-providers=events

Retrieves relevant events from Windows Event Log.


Argument Descriptions for the UiPath.DiagTool Utility


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.