PHPackages                             maplephp/prompts - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. maplephp/prompts

ActiveLibrary[CLI & Console](/categories/cli)

maplephp/prompts
================

PHP Prompts is a pretty, interactive, lightweight, and user-friendly CLI (Command Line Interface) PHP library designed for seamless use across Linux, Unix, Darwin, and Windows.

v1.2.0(5mo ago)543213Apache-2.0PHPPHP >=8.2

Since May 20Pushed 5mo ago1 watchersCompare

[ Source](https://github.com/MaplePHP/Prompts)[ Packagist](https://packagist.org/packages/maplephp/prompts)[ Docs](https://wazabii.se)[ RSS](/packages/maplephp-prompts/feed)WikiDiscussions main Synced 3w ago

READMEChangelog (10)Dependencies (3)Versions (12)Used By (3)

MaplePHP Prompts
================

[](#maplephp-prompts)

PHP Prompts is a pretty, interactive, lightweight, and user-friendly CLI (Command Line Interface) PHP library designed for seamless use across Linux, Unix, Darwin, and Windows. It allows you to create and manage user prompts in a command-line environment, enabling the collection of various types of input with built-in validation and feedback.

[![Prompt demo](https://camo.githubusercontent.com/ddcccd62b103844eb60c04070f1df26d5214b8990264bb44ecb7c60804d5cdf7/687474703a2f2f77617a616269692e73652f6769746875622d6173736574732f6d61706c657068702d70726f6d70742d76322e676966)](https://camo.githubusercontent.com/ddcccd62b103844eb60c04070f1df26d5214b8990264bb44ecb7c60804d5cdf7/687474703a2f2f77617a616269692e73652f6769746875622d6173736574732f6d61706c657068702d70726f6d70742d76322e676966)

*Note that the prompt may not look as polished on Windows as on Unix, but it will work just as well.*

### Table of Contents

[](#table-of-contents)

- [Installation](#installation)
- [Usage Example](#usage-example)
- [Available Options](#available-options)
- [Available Prompt Types](#available-prompt-types)
- [Command instance](#command-instance)
- [Progress Bar](#progress-bar)
- [Validation](#validation-and-error-handling)

Installation
------------

[](#installation)

To install PHP Prompts, use Composer:

```
composer require maplephp/prompts
```

Usage Example
-------------

[](#usage-example)

Below is an example demonstrating how to use the PHP Prompts library to create interactive prompts and validate user input.

### Step-by-Step Guide

[](#step-by-step-guide)

1. **Initialize**

```
$prompt = new \MaplePHP\Prompts\Prompt();
```

2. **Set the Title and Description for the Prompts**

    This step is optional but provides context for the user.

    ```
    $prompt->setTitle("Hello there!");
    $prompt->setDescription("We need your contact information to stay in touch, thank you.");
    ```
3. **Define the Prompts**

    Define the prompts and their respective settings, including type, message, validation rules, and error messages.

    ```
    $prompt->set([
         "name" => [
             "type" => "text",
             "message" => "Full Name",
             "validate" => [
                 "length" => [1,200]
             ]
         ],
         "email" => [
             "type" => "text",
             "message" => "Email",
             "validate" => [
                 "length" => [1,200],
                 "email" => []
             ],
             "error" => "The email address entered is not valid."
         ],
         "newsletter" => [
             "type" => "toggle",
             "message" => "Receive newsletter?",
         ],
         "method" => [
             "type" => "select",
             "message" => "Preferred contact method?",
             "items" => [
                 "email" => "Email",
                 "phone" => "Phone"
             ],
         ],
         "contactByPhone" => [
             "type" => "continue",
             "items" => function($prevVal) {
                 if($prevVal === "phone") {
                     return [
                         "phone" => [
                             "type" => "text",
                             "message" => "Phone",
                             "validate" => [
                                 "length" => [1,30],
                                 "phone" => []
                             ]
                         ]
                     ];
                 }
                 return false;
             }
         ],
         "confirm" => [
             "type" => "confirm",
             "message" => "Do you wish to continue?"
         ]
    ]);
    ```
4. **Execute the Prompt**

    Prompt the user for input based on the defined prompts above. The collected user input will be saved in the `$prompt` variable.

    ```
    // Execute the prompt
    $prompt = $prompt->prompt();
    // Print out the user inputs
    print_r($prompt);
    ```

Available Options
-----------------

[](#available-options)

1. **type**

    - **Description**: Specifies the type of the prompt (e.g., `text`, `password`, `toggle`, `select`, `list`, `continue`, `message`, `confirm`).
    - **Example**: `"type" => "text"`
2. **message**

    - **Description**: The message or question displayed to the user.
    - **Example**: `"message" => "Enter your full name"`
3. **default**

    - **Description**: A default value for the prompt, used if the user does not provide input.
    - **Example**: `"default" => "Your default value"`
4. **items**

    - **Description**: An array of items to choose from, used with `select` type prompts.
    - **Example**: `"items" => ["Option 1", "Option 2", "Option 3"]`
5. **validate**

    - **Description**: Validation rules for the input. Can be an array of rules or a custom function.
    - **Examples**:
        - Length validation: `"validate" => ["length" => [1, 200]]`
        - Custom function validation: ```
            "validate" => function($input) {
                return strlen($input) >= 3;
            }
            ```
6. **error**

    - **Description**: Error message or function to display when validation fails.
    - **Examples**:
        - Static message: `"error" => "Input is required"`
        - Custom function error: ```
            "error" => function($errorType, $input, $row) {
                if ($errorType === "length") {
                    return "Is required";
                }
                return "Must be a number";
            }
            ```
7. **confirm**

    - **Description**: Message to display upon user confirmation, used with `confirm` type prompts.
    - **Example**: `"confirm" => "Are you sure you want to continue?"`

Available Prompt Types
----------------------

[](#available-prompt-types)

### Summary

[](#summary)

- **text**: Prompts for regular text input.
- **password**: Prompts for masked password input.
- **toggle**: Asks a yes/no question.
- **select**: Provides a list of options for selection.
- **list**: Prompts for a comma-separated list of values.
- **continue**: Continue with input dependent on previous value
- **message**: Displays a message (no input).
- **confirm**: Asks for confirmation before proceeding.

### Details

[](#details)

1. **text**

    - **Description**: Prompts the user for regular text input.
    - **Usage Example**: ```
        "firstname" => [
            "type" => "text",
            "message" => "First name"
        ]
        ```
2. **password**

    - **Description**: Prompts the user for password input, masking the characters as they are typed.
    - **Usage Example**: ```
        "password" => [
            "type" => "password",
            "message" => "Password"
        ]
        ```
3. **toggle**

    - **Description**: Asks the user a yes/no question.
    - **Usage Example**: ```
        "ssl" => [
            "type" => "toggle",
            "message" => "Do you want SSL?"
        ]
        ```
4. **select**

    - **Description**: Provides a list of options for the user to choose from.
    - **Usage Example**: ```
        "select" => [
            "type" => "select",
            "message" => "Select an item below",
            "items" => [
                "Lorem 1",
                "Lorem 2",
                "Lorem 3"
            ]
        ]
        ```
5. **list**

    - **Description**: Prompts the user for a comma-separated list of values.
    - **Usage Example**: ```
        "keyword" => [
            "type" => "list",
            "message" => "Keywords"
        ]
        ```
6. **continue**

    - **Description**: Continue with input dependent on previous value.
    - **Usage Example**: ```
        "continue" => [
           "type" => "continue",
           "items" => function($prevVal) {
              if($prevVal === "phone") {
                  return [
                      "phone" => [
                          "type" => "text",
                          "message" => "Phone",
                          "validate" => [
                              "length" => [1,30],
                              "phone" => []
                          ]
                      ]
                  ];
              }
              return false;
          }
        ]
        ```
7. **message**

    - **Description**: Displays a message to the user. This type does not collect input and will be excluded from the end result array.
    - **Usage Example**: ```
        "message" => [
            "type" => "message",
            "message" => "Lorem ipsum dolor"
        ]
        ```
8. **confirm**

    - **Description**: Asks the user for confirmation before proceeding. Can display a custom confirmation message.
    - **Usage Example**: ```
        "confirm" => [
            "type" => "confirm",
            "message" => "Do you wish to continue?"
        ]
        ```

These prompt types enable a variety of user interactions in a CLI environment, making it easy to collect and validate different kinds of input using the PHP Prompts library.

Command instance
----------------

[](#command-instance)

You also execute some of the prompt above command directly with the Command class.

```
$command = new \MaplePHP\Prompts\Command();
// Print messages and return input
$input = $command->message("Text field", true);
$input = $command->mask("Masked input (password)");
$input = $command->toggle("Toggle yes/no");
$input = $command->select("Choose a value", [
    //...
]);
$input = $command->list("Comma seperated list");
$input = $command->confirm("Confirm");

// Print messages
$command->message("Print message");
$command->title("Print bolded message");
$command->statusMsg("Print blue status message");
$command->approve("Print green approve message");
$command->approve("Print red error message");
```

Progress Bar
------------

[](#progress-bar)

The `progress` method of the `Command` class allows displaying a progress bar with customizable sleep intervals to indicate ongoing operations.

```
$command = new \MaplePHP\Prompts\Command();
$command->progress(1, 100, function($i, $length) {
    return 20;
});
```

Validation and Error Handling
-----------------------------

[](#validation-and-error-handling)

Each prompt can have validation rules and custom error messages. Validation can be defined using built-in rules (e.g., length, email) or custom functions. Errors can be specified as static messages or dynamic functions based on the error type.

### Validation List

[](#validation-list)

1. **required**

    - **Description**: Checks if the value is not empty (e.g., not `""`, `0`, `NULL`).
    - **Usage**: `"required" => []`
2. **length**

    - **Description**: Checks if the string length is between a specified start and end length.
    - **Usage**: `"length" => [1, 200]`
3. **email**

    - **Description**: Validates email addresses.
    - **Usage**: `"email" => []`
4. **number**

    - **Description**: Checks if the value is numeric.
    - **Usage**: `"number" => []`
5. **min**

    - **Description**: Checks if the value is greater than or equal to a specified minimum.
    - **Usage**: `"min" => [10]`
6. **max**

    - **Description**: Checks if the value is less than or equal to a specified maximum.
    - **Usage**: `"max" => [100]`
7. **url**

    - **Description**: Checks if the value is a valid URL (http|https is required).
    - **Usage**: `"url" => []`
8. **phone**

    - **Description**: Validates phone numbers.
    - **Usage**: `"phone" => []`
9. **date**

    - **Description**: Checks if the value is a valid date with the specified format.
    - **Usage**: `"date" => ["Y-m-d"]`
10. **dateTime**

    - **Description**: Checks if the value is a valid date and time with the specified format.
    - **Usage**: `"dateTime" => ["Y-m-d H:i"]`
11. **bool**

    - **Description**: Checks if the value is a boolean.
    - **Usage**: `"bool" => []`
12. **oneOf**

    - **Description**: Validates if one of the provided conditions is met.
    - **Usage**: `"oneOf" => [["length", [1, 200]], "email"]`
13. **allOf**

    - **Description**: Validates if all of the provided conditions are met.
    - **Usage**: `"allOf" => [["length", [1, 200]], "email"]`
14. **float**

    - **Description**: Checks if the value is a float.
    - **Usage**: `"float" => []`
15. **int**

    - **Description**: Checks if the value is an integer.
    - **Usage**: `"int" => []`
16. **positive**

    - **Description**: Checks if the value is a positive number.
    - **Usage**: `"positive" => []`
17. **negative**

    - **Description**: Checks if the value is a negative number.
    - **Usage**: `"negative" => []`
18. **validVersion**

    - **Description**: Checks if the value is a valid version number.
    - **Usage**: `"validVersion" => [true]`
19. **versionCompare**

    - **Description**: Validates and compares if a version is equal/more/equalMore/less... e.g., than withVersion.
    - **Usage**: `"versionCompare" => ["1.0.0", ">="]`
20. **zip**

    - **Description**: Validates ZIP codes within a specified length range.
    - **Usage**: `"zip" => [5, 9]`
21. **hex**

    - **Description**: Checks if the value is a valid hex color code.
    - **Usage**: `"hex" => []`
22. **age**

    - **Description**: Checks if the value represents an age equal to or greater than the specified minimum.
    - **Usage**: `"age" => [18]`
23. **domain**

    - **Description**: Checks if the value is a valid domain.
    - **Usage**: `"domain" => [true]`
24. **dns**

    - **Description**: Checks if the host/domain has a valid DNS record (A, AAAA, MX).
    - **Usage**: `"dns" => []`
25. **matchDNS**

    - **Description**: Matches DNS records by searching for a specific type and value.
    - **Usage**: `"matchDNS" => [DNS_A]`
26. **equal**

    - **Description**: Checks if the value is equal to a specified value.
    - **Usage**: `"equal" => ["someValue"]`
27. **notEqual**

    - **Description**: Checks if the value is not equal to a specified value.
    - **Usage**: `"notEqual" => ["someValue"]`
28. **string**

    - **Description**: Checks if the value is a string.
    - **Usage**: `"string" => []`
29. **equalLength**

    - **Description**: Checks if the string length is equal to a specified length.
    - **Usage**: `"equalLength" => [10]`
30. **lossyPassword**

    - **Description**: Validates password with allowed characters `[a-zA-Z\d$@$!%*?&]` and a minimum length.
    - **Usage**: `"lossyPassword" => [8]`
31. **strictPassword**

    - **Description**: Validates strict password with specific character requirements and a minimum length.
    - **Usage**: `"strictPassword" => [8]`
32. **pregMatch**

    - **Description**: Validates if the value matches a given regular expression pattern.
    - **Usage**: `"pregMatch" => ["a-zA-Z"]`
33. **atoZ**

    - **Description**: Checks if the value consists of characters between `a-z` or `A-Z`.
    - **Usage**: `"atoZ" => []`
34. **lowerAtoZ**

    - **Description**: Checks if the value consists of lowercase characters between `a-z`.
    - **Usage**: `"lowerAtoZ" => []`
35. **upperAtoZ**

    - **Description**: Checks if the value consists of uppercase characters between `A-Z`.
    - **Usage**: `"upperAtoZ" => []`
36. **isArray**

    - **Description**: Checks if the value is an array.
    - **Usage**: `"isArray" => []`
37. **isObject**

    - **Description**: Checks if the value is an object.
    - **Usage**: `"isObject" => []`
38. **boolVal**

    - **Description**: Checks if the value is a boolean-like value (e.g., "on", "yes", "1", "true").
    - **Usage**: `"boolVal" => []`

### Usage Example

[](#usage-example-1)

Here is an example of how to use the validation functions in the prompt library:

```
$inp->set([
    "firstname" => [
        "type" => "text",
        "message" => "First name",
        "validate" => [
            "length" => [1, 200],
            "required" => []
        ],
        "error" => "Required"
    ],
    "email" => [
        "type" => "text",
        "message" => "Email",
        "validate" => [
            "length" => [1, 200],
            "email" => []
        ]
    ],
    "age" => [
        "type" => "text",
        "message" => "Age",
        "validate" => [
            "number" => [],
            "min" => [18]
        ]
    ]
]);
```

Conclusion
----------

[](#conclusion)

PHP Prompts provides a straightforward way to create interactive command-line interfaces in PHP. By defining prompts, validation rules, and error messages, developers can easily gather and validate user input in a CLI environment.

###  Health Score

44

—

FairBetter than 91% of packages

Maintenance71

Regular maintenance activity

Popularity20

Limited adoption so far

Community17

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 82.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~66 days

Recently: every ~117 days

Total

10

Last Release

163d ago

PHP version history (2 changes)v1.0.0PHP >=8.0

v1.2.0PHP >=8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/724b188e785081275926c5b9c07082e2b3f4afb797efdda61eb1630457e17824?d=identicon)[wazabii](/maintainers/wazabii)

---

Top Contributors

[![wazabii8](https://avatars.githubusercontent.com/u/6400238?v=4)](https://github.com/wazabii8 "wazabii8 (38 commits)")[![CreativeWaDev](https://avatars.githubusercontent.com/u/153771800?v=4)](https://github.com/CreativeWaDev "CreativeWaDev (4 commits)")[![danielRConsid](https://avatars.githubusercontent.com/u/169045496?v=4)](https://github.com/danielRConsid "danielRConsid (4 commits)")

---

Tags

clicmdcommand-linecommand-line-interfacecommand-line-toolcross-oscross-platformdarwininteractivelinuxphpprettypromptterminalunixwindowsphpclicommand-lineunixlightweightlinuxwindowscross-platformpromptdarwincross-os

### Embed Badge

![Health badge](/badges/maplephp-prompts/health.svg)

```
[![Health](https://phpackages.com/badges/maplephp-prompts/health.svg)](https://phpackages.com/packages/maplephp-prompts)
```

###  Alternatives

[nunomaduro/collision

Cli error handling for console/command-line PHP applications.

4.6k348.7M10.4k](/packages/nunomaduro-collision)[nunomaduro/laravel-console-menu

Laravel Console Menu is an output method for your Laravel/Laravel Zero commands.

815424.6k52](/packages/nunomaduro-laravel-console-menu)[nunomaduro/laravel-console-task

Laravel Console Task is a output method for your Laravel/Laravel Zero commands.

2592.3M13](/packages/nunomaduro-laravel-console-task)[nunomaduro/laravel-console-summary

A Beautiful Laravel Console Summary for your Laravel/Laravel Zero commands.

672.2M4](/packages/nunomaduro-laravel-console-summary)[nunomaduro/laravel-console-dusk

Laravel Console Dusk allows the usage of Laravel Dusk in Laravel/Laravel Zero artisan commands.

16357.3k8](/packages/nunomaduro-laravel-console-dusk)[rahul900day/laravel-console-spinner

Laravel Console Spinner is a spinner output for Laravel command line.

76128.8k1](/packages/rahul900day-laravel-console-spinner)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)