seldaek / cli-prompt

Allows you to prompt for user input on the command line, and optionally hide the characters they type

CLI-Prompt

While prompting for user input using fgets() is quite easy, sometimes you need to prompt for sensitive information. In these cases, the characters typed in by the user should not be directly visible, and this is quite a pain to do in a cross-platform way.

This tiny package fixes just that for you:

<?php

echo 'Say hello: ';

$answer = Seld\CliPrompt\CliPrompt::hiddenPrompt();

echo 'You answered: '.$answer . PHP_EOL;

// Output in the CLI:
// 
// Say hello:
// You answered: hello

Installation

composer require seld/cli-prompt

API

• Seld\CliPrompt\CliPrompt::hiddenPrompt($allowFallback = false);

  Prompts the user for input and hides what they type. If this fails for any reason and $allowFallback is set to true the prompt will be done using the usual fgets() and characters will be visible.

• Seld\CliPrompt\CliPrompt::prompt();

  Regular user prompt for input with characters being shown on screen.

In both cases, the trailing newline the user enters when submitting the answer is trimmed.

Requirements

PHP 5.3 and above

License

CLI-Prompt is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

• This project uses hiddeninput.exe to prompt for passwords on Windows, sources and details can be found on the github page of the project.

cli-prompt's Issues

Usage notice at friendica/friendica

We are now using cli-prompt over at https://github.com/friendica/friendica for our custom console commands!

Thanks for your work, especially the Windows port!

Consider using functions instead of a class with static methods

I'm probably being a PITA now that you already released v1, but consider this next time.

Seld\CliPrompt\prompt();
Seld\CliPrompt\hiddenPrompt($fallback = false);