Script Console Tab

The Scripts Console allows you to write scripts which run within ZAP.
It is made up of:

  • A toolbar
  • A text area (top) in which you can write your scripts
  • An output text area (bottom) for debug and error messages, with “print” statements.

You can run ‘Stand alone’ scripts from within this tab using the ‘Run’ button on the tab toolbar.
All other types of scripts will be run when enabled or if explicitly invoked.

To create a new script or to load or switch scripts see the The Scripts ‘tree’ tab.

Right-click in the script area for display and editing options.

In ZAP versions after 2.7.0 if the script currently displayed in the console is changed by another program then you will be given the option to keep the script in the console or replace it with the changed script.
If a script is changed by another program when it is not being displayed and has not previously been changed in the script console then that script will loaded and the new contents will be used when the script is run.

Templates can be viewed in the console but cannot be edited.

Auto-complete

The console supports a limited form of auto-complete, controlled by a button on the toolbar.
When enabled a popup will be shown when you type the name of one of the defined parameters followed by a dot - this will show you all of the methods available for you to call. Selecting one of them will insert the method and parameters into your script. If you type another dot immediately after the method call then you will be shown another prompt for the methods available to the return type, if any. You will be able to keep expanding the types returned until you start typing something else.

See also

The Scripts add-on
The Scripts ‘tree’ tab