> 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/ip_picker.md).

# IP\_PICKER

`IP_PICKER` Prompt the user to interactively enter an IPv4 address via the Pager UI

### When to use it <a href="#when-to-use-it" id="when-to-use-it"></a>

Use `IP_PICKER` any time a payload needs an IP address, such as for connecting to a host.

#### Syntax <a href="#syntax" id="syntax"></a>

```none
IP_PICKER [text prompt] [default IP]
```

**text prompt&#x20;*****required***

Text prompt / dialog title shown to the user. Text prompts should be kept short enough to fit on the device display.

**default IP&#x20;*****required***

Default IP address when the picker launches. Must be an empty string (`""`) for a blank prompt.

{% hint style="warning" %}
A default IP should typically be provided. To prompt the user with no default, use a blank quoted string (`""`) for the IP parameter.
{% endhint %}

<figure><img src="/files/mn6WA0zVKcuDbxcsMeiK" alt="The IP picker dialog"><figcaption><p>The IP picker dialog</p></figcaption></figure>

<figure><img src="/files/FFgbHiR11HnMYD7yOLbM" alt="The IP picker editor"><figcaption><p>The IP picker editor</p></figcaption></figure>

### Results <a href="#results" id="results"></a>

`IP_PICKER` will wait until the user has made a selection, pausing the payload.

`IP_PICKER` exits with a return code of `0` if the user continues, and non-zero if the user cancels.

`IP_PICKER` returns the IP address as the output.

### Examples <a href="#examples" id="examples"></a>

```bash
__userip=$(IP_PICKER "Target IP" "1.2.3.4") || exit 0
```

```bash
__userip=$(IP_PICKER "No default IP" "") || exit 0
```

{% hint style="info" %}
Remember to enclose the prompt text in quotes if it contains spaces!
{% 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/ip_picker.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.