> For the complete documentation index, see [llms.txt](https://documentation.hak5.org/wifi-pineapple-pager/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.hak5.org/wifi-pineapple-pager/payloads-1/introduction-to-payloads.md).

# Introduction to Payloads

{% hint style="info" %}
This section of the manual is being updated, expect more information about payload creation and Pineapple DuckyScript Commands soon!
{% endhint %}

The WiFi Pineapple Pager is expandable via the *payload system*.

Payloads are scripts integrated with DuckyScript commands which leverage the power of the WiFi Pineapple system.

DuckyScript is the payload language of Hak5 gear.

Originating on the Hak5 USB Rubber Ducky as a standalone language, the Packet Squirrel uses DuckyScript commands to bring the ethos of easy-to-use actions to the payload language.

DuckyScript commands are always in all capital letters to distinguish them from other system or script language commands. Typically, they take a small number of options (or sometimes no options at all).

Payloads can be constructed of DuckyScript commands alone, or combined with the power of bash scripting and system commands to create fully custom, advanced actions.

### Payloads  <a href="#payloads" id="payloads"></a>

The Pager uses three types of payloads:

**Alert payloads**&#x20;

Alert payloads are small, typically non-interactive scripts launched in response to conditions in the environment. Alert payloads can take simple actions like displaying a message, playing a ringtone,

Alert payloads can be run for various conditions which can happen at any time while the Pineapple is operating:

* WPA handshake capture
* Wi-Fi Denial of Service attacks
* A client connecting to a Pineapple access point
* Authentication details captured by a Pineapple access point

Alert payloads can be run at any time when background events occur; they should be slim and minimal, as they may be launched repeatedly.

**User payloads**&#x20;

User payloads are the fully-featured big brother to Alert payloads.

User payloads are run by the user from the Payload section of the main device dashboard.

User payloads expose the full range of Pineapple DuckyScript commands, which lets developers construct user interactions for entering text, IP addresses, MAC addresses, confirming actions, displaying logs and status results, and more.

**Recon payloads**&#x20;

Recon payloads are run against access points and clients discovered by the recon process.

Recon payloads also utilize the full range of Pineapple DuckyScript commands and user interactions.

{% hint style="info" %}
Already familiar with DuckyScript commands? Please keep reading!\
\
The DuckyScript ecosystem strives to bring common commands to the entire line of Hak5 products, however commands unique to each product will not work on other devices. Payloads may look similar, but not all commands will be available on all devices (The WiFi Pineapple Pager is not a keyboard injection device, for instance, so inject commands from the USB Rubber Ducky will not work).
{% endhint %}

### Payload repository  <a href="#payload-repository" id="payload-repository"></a>

The official Hak5 payload repository is available at <https://github.com/hak5/wifipineapplepager-payloads/tree/master>

This includes Hak5 example scripts and community contributed payloads.

Payloads in the repository are organized into `alert`, `recon`, and `user`, with further sub-categories.

{% hint style="warning" %}
Payloads from the Payload Repository are provided for educational purposes only. Hak5 gear is intended for authorized auditing and security analysis purposes only where permitted subject to local and international laws where applicable. Users are solely responsible for compliance with all laws of their locality. Hak5 LLC and affiliates claim no responsibility for unauthorized or unlawful use.\
\
While Hak5 audits payloads before they are accepted into the payload repository, use of third party payloads is at your own risk.
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://documentation.hak5.org/wifi-pineapple-pager/payloads-1/introduction-to-payloads.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
