Detailed Usage Guide

Usage

This page is intended to explain how Pacu works in detail, for advanced users.

Interacting with modules

• ls or list will list the available modules for the regions that were set in the current session.
• search x will search all modules and return modules that include x in their name.
• help module_name will return the applicable help information for the specified module.
• run module_name or exec module_name will run the specified module with its default parameters.
• run module_name --regions eu-west-1,us-west-1 will run the specified module against the eu-west-1 and us-west-1 regions (for modules that support the --regions argument), regardless of what regions are set for the current session.

Configuring Regions

By default, every supported region is used for each module when possible.

Supported regions can be found in Pacu by typing the regions command.

You can use set_regions to declare a specific set of regions to focus on in the current session. If you do choose to manually set target regions, Pacu will ignore any regions that are not supplied in that command. For example, if your target only uses AWS in us-east-1 and us-west-2, then you would enter set_regions us-east-1 us-west-2 and every module from there on out would only target us-east-1 and us-west-2. When listing modules using the ls or list commands, only modules that are applicable to the regions you set will show up.