Command Line

(REQCHECKER™ EXPERT only)

Analysis can also be launched using the command line. Command line features require REQCHECKER™ EXPERT or REQCHECKER™ EXPERT Floating.

Syntax:

 reqcheckercmd.exe command [options]
  • -add <document path> command : Adds a file to the project of the current folder
  • -edit <.cover file path> command : open editor on the project cover file
  • -help command : Displays the command line help
  • -run <.cover file path> command : computes coverage and generates Markdown Report
  • -restserver <.cover file path> command : starts the local REST API and embedded project viewer on the project cover file
  • -english option : Forces English language
  • -german option : Forces German language
  • -nostat option : Never send statistics
  • -logdebug option : Set log level to debug
  • -rcxls option for -run command : add the Coverage Matrix to the report list
  • -rhtml option for -run command : add the Printable HTML Report to the report list
  • -rmd option for -run command : add the Markdown Report to the report list
  • -rsxls option for -run command : add the Verification Table to the report list
  • -rsxlsupdate <existing .xlsx or .xlsm report path> option for -run command : add a new Verification Table by updating a copy of an existing verification report. Relative paths are resolved from the directory containing the .cover file. The existing report is not modified.
  • -rxml option for -run command : adds the XML Export to the report list
  • -reca option for -run command : adds the Eclipse Content Assist Export to the report list
  • -rjava option for -run command : adds the Java Enum Export to the report list

For example :

"%localappdata%\reqchecker-application\reqcheckercmd.exe" -run "c:\my project\myfile.cover"

Updating an existing verification report located next to the .cover file:

"%localappdata%\reqchecker-application\reqcheckercmd.exe" -run "c:\my project\myfile.cover" -rsxlsupdate "verification.xlsx"

Report options can be combined. For example, this command creates both an updated verification report and a coverage report:

"%localappdata%\reqchecker-application\reqcheckercmd.exe" -run "c:\my project\myfile.cover" -rsxlsupdate "reports\verification.xlsm" -rcxls

Starting the local REST server:

"%localappdata%\reqchecker-application\reqcheckercmd.exe" -restserver "c:\my project\myfile.cover"

The command prints the REST connection values to the console:

REST_SERVER_URL=http://127.0.0.1:9490/reqchecker/v4.0
REST_SERVER_TOKEN=...
REST_SERVER_TOKEN_EXPIRES_IN=10800

The token is valid for 3 hours and must be sent with API requests:

curl -H "X-Reqchecker-Token: %REST_SERVER_TOKEN%" "%REST_SERVER_URL%/application"