Detailed Usage Guide

Usage

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.

Pacu comes with a service_regions.json file in the modules folder, but the update_regions command was added to ensure that the list is up to date. By running update_regions, Pacu will try to use pip3 (then pip if it fails, then it will ask you if that fails) to update the Python libraries boto3 and botocore. Then it will try to discover the path to where pip is storing libraries at so it can fetch the most up-to-date list of regions from the botocore folder.

Other commands

• set_keys will create a new set of AWS keys within the Pacu session and set them as the active set.
• swap_keys will allow you to swap between sets of AWS keys stored in the current Pacu Session.
• whoami will list information related to the AWS keys currently set as the default. This can include information such as what their username is, what keys are being used, what permissions the user has, and more.
• data will return all data related to the current session. This includes data about the actual Pacu session as well as all of the collected AWS data over the duration of the session.
• services will return a list of AWS services that have data currently stored in the active session.
• data <service> will return all the data stored in the database for any service returned from the services command.
• quit or exit will exit out of Pacu.