SugarReadline
Interactive prompts — text, confirm, select, multi-select, textarea
Text, Confirm, Selection, MultiSelect, and Textarea prompts with full keyboard handling, filter-as-you-type, and pagination. State-machine model — no external readline dependency.
Install
composer require sugarcraft/sugar-readlineQuickstart
use SugarCraft\Readline\{TextPrompt, SelectionPrompt, MultiSelectPrompt};
// Text prompt
$name = TextPrompt::new('Your name:')->HandleChar('A')->Confirm()->Value();
// Selection prompt
$lang = SelectionPrompt::new('Pick a language:', ['PHP', 'Go', 'Rust', 'Python'])
->HandleKey('enter');
// Multi-select with constraints
$tools = MultiSelectPrompt::new('Pick tools:', ['vim', 'git', 'docker', 'php'])
->WithMinSelections(1)
->WithMaxSelections(3)
->HandleKey('space')
->HandleKey('enter');What's in the box
TextPromptSingle-line input with placeholder, default value, password masking support.
ConfirmationPromptYes / No with customizable labels and default.
SelectionPromptArrow-key selection with filter-as-you-type and pagination.
MultiSelectPromptMulti-item selection with min/max enforcement, marker (◉/○), pagination.
TextareaPromptMulti-line editor with cursor movement, line count display.
Source & demos
- Source on GitHub
- Full README
- Runnable examples
- Port of erikgeiser/promptkit (Go upstream)
API
| Class | Method | Description |
|---|---|---|
| TextPrompt | new(question) | Create text prompt |
| TextPrompt | confirm() | Confirm input |
| ConfirmationPrompt | new(question) | Create yes/no prompt |
| SelectionPrompt | new(question, options) | Create selection prompt |
| MultiSelectPrompt | new(question, options) | Create multi-select prompt |
| MultiSelectPrompt | withMinSelections(n) | Set minimum selections |
| MultiSelectPrompt | withMaxSelections(n) | Set maximum selections |
| TextareaPrompt | new(question) | Create textarea prompt |
