Command syntax

AppScan® Source command line interface (CLI) commands conform to a usage template with required and optional arguments, similar to a command shell. CLI commands are not case sensitive and do not require switches for different arguments.

The syntax for all CLI commands is:

command required_args [optional_args]

The command descriptions and usage adhere to the following conventions:

  • command: Actual command, identified in a bold Courier font.
  • Required arguments: Identified in courier font.
  • Literals: Identified by italics.
  • Optional arguments: Enclosed in brackets [ ].
  • Required arguments that have options: Enclosed in braces { }.
  • Some arguments require associated values (identified by angle brackets < >). If these arguments are used without including values, you will receive an error message.
  • Each command has a long name and an abbreviation. Find the abbreviations in parentheses in the command heading.
  • All command names are one word with no spaces or tabs.
  • Arguments do not require command switches but are order dependent.
    Important: It is important to remember that arguments are order dependent.

Arguments may contain spaces and tabs. Enclose arguments that contain spaces or tabs with double quotation marks (" "), otherwise they are parsed as multiple arguments.