Exécuter Visual Expert en ligne de commande

L'outil en ligne de commande de Visual Expert exécute les tâches de Visual Expert sans ouvrir l'interface. Vous pouvez l'appeler depuis un script batch ou une tâche planifiée.

Il permet de :

analyser un projet ;
générer une documentation HTML du code ;
exporter des rapports de revue de code au format JUnit, JSON ou XML ;
lister vos projets Visual Expert ;
installer ou désinstaller le service de planification.

L'outil travaille sur des projets existants. Créez et configurez d'abord votre projet dans Visual Expert.

1. Ouvrir l'invite de commandes et accéder au dossier de Visual Expert

Le programme à lancer, Novalys.VisualExpert.Console.CommandLine.exe, se trouve dans le dossier d'installation de Visual Expert.

Ouvrez le menu Démarrer de Windows, tapez cmd, puis cliquez sur Invite de commandes.
Accédez au dossier d'installation de Visual Expert. Adaptez le nom du dossier à votre version de Visual Expert :

cd "C:\Program Files\Novalys\Visual Expert 2026"

Dans les exemples ci-dessous, remplacez Mon projet par le nom de votre projet. Conservez les guillemets autour des noms et des chemins qui contiennent des espaces.

2. Options de la ligne de commande

Option courte	Option longue	Rôle
`-p`	`--project`	Indique le nom du projet.
`-a`	`--Analysis`	Lance une nouvelle analyse du projet.
`-d`	`--Documentation`	Génère la documentation du code source analysé.
`-t`	`--DocumentationType`	Sélectionne le type de documentation : `reference` ou `codereview`.
`-O`	`--ReportOutputPath`	Définit le chemin du fichier de rapport de revue de code.
`-R`	`--ReportType`	Sélectionne le type de rapport : `CodeRuleBased` ou `DefectSummaryBased`.
`-F`	`--ReportFormat`	Sélectionne le format du rapport : `JUNIT`, `JSON` ou `XML`, selon le type de rapport.
`-L`	`--GetProjectsList`	Liste les projets Visual Expert et génère un fichier contenant cette liste.
`-I`	`--InstallService`	Installe le service de planification.
`-U`	`--UninstallService`	Désinstalle le service de planification.
`-v`	`--version`	Affiche la version de l'outil.
	`--help`	Affiche l'aide et des exemples d'utilisation.

Les options sont sensibles à la casse. Saisissez-les exactement comme indiqué, y compris les majuscules de -O, -R, -F, -L, -I et -U.

3. Analyser un projet

Associez -a à -p pour lancer une nouvelle analyse du projet :

Novalys.VisualExpert.Console.CommandLine.exe -a -p "Mon projet"

L'outil affiche la progression de chaque étape de l'analyse. La dernière ligne confirme la fin de l'analyse :

Project Name : Mon projet
[######----]  61% |
------------------------------------------------------------
Title:Source Code successfully recorded
------
Status:Info
Message:The Duration of the operation is: 00:00:00.2368349

...

[##########] 100% |
Analysis completed successfully for the project Mon projet.

4. Générer une documentation HTML du code

Utilisez -d avec le nom du projet, et sélectionnez le type de documentation avec -t. Si vous omettez -t, Visual Expert génère la documentation du code source.

Les deux types sont des documents HTML à consulter dans un navigateur web. Pour obtenir un fichier exploitable par d'autres outils, voir l'étape 5.

Documentation du code source (`-t reference`)

Novalys.VisualExpert.Console.CommandLine.exe -d -p "Mon projet" -t reference

Documentation de revue de code (`-t codereview`)

Novalys.VisualExpert.Console.CommandLine.exe -d -p "Mon projet" -t codereview

La dernière ligne du résultat indique le chemin de la documentation générée. Ouvrez ce fichier index.html dans un navigateur web :

Project Name : Mon projet
Documentation Type : codereview
[##########] 100% |
Documentation generated for the project Mon projet.

C:\ProgramData\Novalys\VEDocs\Mon projet_2026-10-26_10-21-00\index.html

Pour modifier le contenu et la mise en forme de la documentation, ouvrez votre projet dans Visual Expert, cliquez sur l'onglet Documentation, puis sur Advanced Settings. Le Documentation Center s'ouvre. Dans sa section Settings, choisissez le modèle (Template), le style (Style) et le contenu à inclure. Voir Documentation du code source.

5. Exporter un rapport de revue de code

Ajoutez les options du rapport à la commande d'analyse (voir l'étape 3). Visual Expert génère le rapport à la fin de l'analyse.

-O : chemin du fichier de rapport ;
--ReportType : type de rapport ;
--ReportFormat : format du fichier.

Indiquez toujours le type de rapport et le format.

Type de rapport	Formats	Contenu
`CodeRuleBased`	`JUNIT`	Résultats des règles de code, au format JUnit XML.
`DefectSummaryBased`	`JSON` ou `XML`	Nombre de défauts par sévérité, statut et type.

Dans les exemples ci-dessous, le caractère ^ en fin de ligne signifie que la commande continue sur la ligne suivante. Vous pouvez coller l'exemple tel quel dans l'invite de commandes, ou saisir la commande sur une seule ligne sans les ^.

Rapport des règles de code au format JUnit

Novalys.VisualExpert.Console.CommandLine.exe -a -p "Mon projet" ^
 -O "C:\temp\code-rules.xml" ^
 --ReportType CodeRuleBased --ReportFormat JUNIT

À la fin de l'analyse, l'outil confirme l'emplacement du rapport :

Output file generated at C:\temp\code-rules.xml

Analysis completed successfully for the project Mon projet.

Les critères de réussite et d'échec de chaque règle de code proviennent du profil de revue de code (Code Review Profile) du projet. Sélectionnez ce profil dans Visual Expert, sous Project Settings > Code Inspection.

Le rapport contient :

un élément testsuite par application, avec sa taille et ses métriques ;
un élément testcase par règle de code, avec le nombre d'anomalies actives, la sévérité et le type ;
un élément failure lorsque le nombre d'anomalies dépasse la limite fixée par le profil de revue de code ;
un attribut url qui ouvre les défauts de la règle dans Visual Expert Web.

JUnit XML est un format standard de résultats de tests. La plupart des serveurs d'intégration continue savent le lire.

Extrait du rapport

<testsuites analysisId="15" analysisDate="10/15/2026 3:13:40 PM">
  <testsuite name="Mon application" size="1853" reliability="28" security="2"
             maintainability="1275" comments="6.21 %"
             codeReviewProfile="LegacyCode" tests="79" failures="49">
    <testcase name="A primary key should be specified during table creation"
              coderuleId="VETSQLRULE57" activeIssues="12"
              severity="Critical" type="Maintainability"
              url="https://votre-serveur-ve-web/codeinspection/1002/15/rules/defects/VETSQLRULE57">
      <failure message="Found 12 issues across 1853 lines of code, exceeding the maximum allowed limit of 1 issues for this rule." />
    </testcase>
    <testcase name="CATCH clauses should do more than rethrow"
              coderuleId="VETSQLRULE50" activeIssues="1"
              severity="Minor" type="Maintainability"
              url="https://votre-serveur-ve-web/codeinspection/1002/15/rules/defects/VETSQLRULE50" />
    ...
  </testsuite>
</testsuites>

Synthèse des défauts au format JSON

Novalys.VisualExpert.Console.CommandLine.exe -a -p "Mon projet" ^
 -O "C:\temp\defects.json" ^
 --ReportType DefectSummaryBased --ReportFormat JSON

Synthèse des défauts au format XML

Novalys.VisualExpert.Console.CommandLine.exe -a -p "Mon projet" ^
 -O "C:\temp\defects.xml" ^
 --ReportType DefectSummaryBased --ReportFormat XML

La synthèse des défauts contient :

un résumé : lignes de code, défauts actifs, défauts critiques et majeurs, nouveaux défauts, bugs, vulnérabilités, défauts assignés et défauts résolus ;
le nombre de défauts actifs et nouveaux par sévérité ;
le nombre de défauts par statut ;
le nombre de défauts actifs et nouveaux par type.

Chaque compteur est accompagné d'une url qui ouvre la liste de défauts correspondante dans Visual Expert Web, avec les filtres déjà appliqués.

Extrait du rapport (JSON)

{
  "analysisId": 14,
  "reportType": "DefectSummaryBased",
  "analysisDate": "2026-10-15T15:10:12.9961477",
  "projectName": "Mon projet",
  "summary": {
    "linesOfCode": 1853,
    "activeDefects": {
      "count": 506,
      "url": "https://votre-serveur-ve-web/codeinspection/1002/14/defects?filter=Active"
    },
    "criticalAndMajorDefects": {
      "count": 130,
      "url": "https://votre-serveur-ve-web/codeinspection/1002/14/defects?filter=Active&severity=Critical&severity=Major"
    },
    ...
  },
  "defectsBySeverity": [
    {
      "severity": "Critical",
      "activeDefects": {
        "count": 71,
        "url": "https://votre-serveur-ve-web/codeinspection/1002/14/defects?filter=Active&severity=Critical"
      },
      ...
    },
    ...
  ],
  "defectsByStatus": [ ... ],
  "defectsByType": [ ... ]
}

6. Lister vos projets Visual Expert

Novalys.VisualExpert.Console.CommandLine.exe -L

Cette commande affiche le nom de chaque projet, à saisir avec l'option -p. Elle génère aussi un fichier contenant cette liste.

Total 12 projects found
SQL Server Sample project
Oracle Sample project
PB+Oracle Sample project
PB+SQL Server Sample project
PB Sample project
...
Project list file successfully generated

7. Installer ou désinstaller le service de planification

Le service de planification (VisualExpertScheduling) exécute les tâches planifiées dans Visual Expert, par exemple la génération planifiée de la documentation.

Ces commandes nécessitent des droits d'administrateur. Ouvrez le menu Démarrer de Windows, tapez cmd, faites un clic droit sur Invite de commandes, puis cliquez sur Exécuter en tant qu'administrateur. Accédez ensuite au dossier d'installation de Visual Expert (voir l'étape 1).

Installer le service de planification

Novalys.VisualExpert.Console.CommandLine.exe -I

VisualExpertScheduling service install successfully.

Désinstaller le service de planification

Novalys.VisualExpert.Console.CommandLine.exe -U

VisualExpertScheduling service uninstall successfully.

8. Afficher l'aide ou la version

Lister toutes les options avec des exemples d'utilisation

Novalys.VisualExpert.Console.CommandLine.exe --help

Afficher la version de l'outil

Novalys.VisualExpert.Console.CommandLine.exe -v

2026.10.26.1021