How to Run Visual Expert from Command Line

run visual expert from command line

1. Access the Visual Expert folder

Open a command prompt and navigate to the VE 2019 installation folder.

run VE from command line

 

2. Check out the commands available

Run "Novalys.VisualExpert.Console.exe --help" to list the commands available.

run visual expert from command line - list of commands

3. Start a Code Analysis

To start a code Analysis, execute the following command:
Novalys.VisualExpert.Console.exe -a -p "<Project Name>

For Example: Novalys.VisualExpert.Console.exe -a -p "SQL Server Sample project"

run visual expert from command line - run code analysis

Once the Code Analysis is completed, the following message is prompted:

run visual expert from command line - code analysis results

4. Generate a Source Code Documentation

To generate a documentation, execute the command below. 

Novalys.VisualExpert.Console.exe -d -p "<Project Name>

  • Example 1: Novalys.VisualExpert.Console.exe -d -p "SQL Server Sample project"
  • Example 2: Novalys.VisualExpert.Console.exe -d -p "SQL Server Sample project" -t reference Note: the documentation template “reference documentation” is used by default (see visual Expert documentation settings for more details about this template, or customize its content and style). 

Once the documentation is generated, the folder containing the HTML document is indicated. Copy that path and open in a web browser to visualize it.

run visual expert from command line - generate source code documentation

5. Generate a Code Review Documentation

You can choose to generate a code review documentation, by specifying the documentation type as shown below:

Novalys.VisualExpert.Console.exe -d -p "<Project Name>" -t codereview

For Example: Novalys.VisualExpert.Console.exe -d -p "SQL Server Sample project" -t codereview

Once the documentation is generated, the folder containing the HTML document is indicated. Copy that path and open in a web browser to visualize it.
You can refer to the visual Expert documentation settings for more details about this template, or customize its content and style.

run visual expert from command line - generate code review report

Visual Expert, PowerBuilder, Oracle, SQL Server, Configuration