unstale

npm / @clack/prompts

@clack/prompts

What changed in @clack/prompts 1, from its official release notes, upgrade guides and advisories. Sources checked 2026-10-18.

8 breaking46 new APIs and options10 behavior and defaults25 fixes and other

See which of these apply to your code, ranked, in your agent:

npx @unstale/cli init

@unstale/cli 0.1.1 on npm

@clack/prompts 189 changes

Breaking changes 8

  • The default formatter of note() no longer dims lines; provide a format() function to restore the old behavior.

    1.6.0release notes

  • The package now declares a Node.js >=20.12 requirement.

    1.3.0release notes

  • The package is now distributed as ESM-only instead of being dual-published as CJS and ESM.

    1.0.0release notes

  • A placeholder is a visual hint rather than a tabbable value.

    1.0.0release notes

  • The path prompt is changed to be an autocomplete prompt.

    1.0.0release notes

  • Progress bars use a distinct cancel method instead of stop with a status code.

    1.0.0release notes

  • Progress bar errors use a distinct error method instead of stop with a status code.

    1.0.0release notes

  • Spinner errors use a distinct error method instead of stop with a status code.

    1.0.0release notes

New APIs and options 46

  • Prompts support asynchronous validation.

    1.8.0release notes

  • Adds opt-in Tab completion: pressing Tab fills the input with the focused suggestion and shows a completion hint; default behavior is unchanged.

    1.8.0release notes

  • Exports the CANCEL_SYMBOL constant from @clack/prompts.

    1.8.0release notes

  • The select, multiselect, and groupMultiselect prompts accept showInstructions; keyboard hints remain shown by default, and passing false hides them.

    1.7.0release notes

  • Adds a maxItems option to groupMultiselect.

    1.4.0release notes

  • groupMultiselect now supports scrolling.

    1.4.0release notes

  • Adds a prompt for multi-line text input.

    1.3.0release notes

  • Adds a placeholder option; when the input is empty, pressing tab sets the value to the placeholder.

    1.2.0release notes

  • Adds a date prompt with format support for YMD, MDY, and DMY.

    1.2.0release notes

  • The confirm prompt gains a vertical arrangement option.

    1.0.1release notes

  • The confirm prompt now supports the withGuide option.

    1.0.1release notes

  • The password prompt now supports the withGuide option.

    1.0.1release notes

  • The select prompt now supports the withGuide option.

    1.0.1release notes

  • The selectKey prompt now supports the withGuide option.

    1.0.1release notes

  • The spinner prompt now supports the withGuide option.

    1.0.1release notes

  • The prompts package adds an autocomplete-multiselect component.

    1.0.0release notes

  • Autocomplete multiselect adds a required option.

    1.0.0release notes

  • The prompts package adds an autocomplete component.

    1.0.0release notes

  • Autocomplete multiselect accepts a custom filter function, enabling filtering such as fuzzy searching.

    1.0.0release notes

  • AutocompletePrompt is added to core, with autocomplete and autocomplete-multiselect components in the prompts package.

    1.0.0release notes

  • A box prompt renders boxed text, similar to a note.

    1.0.0release notes

  • Select-key adds a caseSensitive option.

    1.0.0release notes

  • A positive integer groupSpacing adds that number of new lines between groups.

    1.0.0release notes

  • Multi-select prompts allow disabled options.

    1.0.0release notes

  • The note prompt adds a format option for formatting individual lines.

    1.0.0release notes

  • The note prompt supports withGuide.

    1.0.0release notes

  • The password prompt can automatically clear input when validation fails.

    1.0.0release notes

  • A progress prompt displays a progress bar.

    1.0.0release notes

  • All prompts accept a custom input stream.

    1.0.0release notes

  • All prompts accept a custom output stream.

    1.0.0release notes

  • All prompts accept withGuide to disable the default Clack border.

    1.0.0release notes

  • Select prompts allow disabled options.

    1.0.0release notes

  • Setting selectableGroups to false prevents selecting top-level groups while leaving their children selectable.

    1.0.0release notes

  • Prompt settings, including messages, are accessible directly.

    1.0.0release notes

  • Spinner cancellation uses a distinct cancel method instead of stop with a status code.

    1.0.0release notes

  • Spinner instances can customize their cancellation message.

    1.0.0release notes

  • A clear method stops and clears a spinner.

    1.0.0release notes

  • Spinner instances can customize their error message.

    1.0.0release notes

  • The spinner prompt supports custom frames.

    1.0.0release notes

  • The spinner prompt adds a styleFrame option.

    1.0.0release notes

  • A SpinnerResult type describes the return type of spinner.

    1.0.0release notes

  • A taskLog prompt provides log output that is cleared on success.

    1.0.0release notes

  • Task logs can use groups, and groups can have scrolling windows of logs.

    1.0.0release notes

  • Global prompt settings can customize spinner cancellation messages.

    1.0.0release notes

  • Global prompt settings can customize spinner error messages.

    1.0.0release notes

  • Prompts store user input separately from their value.

    1.0.0release notes

Behavior and default changes 10

  • The guide bar rendered with withGuide enabled is styled grey to match the gutter drawn by log, note, and the spinner.

    1.8.0release notes

  • Text prompts render validation state.

    1.8.0release notes

  • Shows keyboard instruction footers in the active state, with no option to disable them.

    1.6.0release notes

  • Shows keyboard instruction footers in the active state, with no option to disable them.

    1.6.0release notes

  • Shows keyboard instruction footers in the active state, with no option to disable them.

    1.6.0release notes

  • Autocomplete and select prompts support wrapping.

    1.0.0release notes

  • Prompts support signals so they can be aborted.

    1.0.0release notes

  • Spinner output wraps to support multi-line and wrapped messages.

    1.0.0release notes

  • Spinner cancellation can be detected via CTRL+C, allowing graceful handling of user interruptions.

    1.0.0release notes

  • Log messages show a symbol when withGuide is true.

    1.0.0release notes

Fixes and other changes 25

  • Prompt return types now specify CANCEL_SYMBOL instead of the broader symbol type, improving type accuracy.

    1.8.1release notes

  • Fixes extra spaces in text prompts when withGuide is enabled.

    1.8.0release notes

  • Various prompts and utilities now handle empty arrays.

    1.7.0release notes

  • Fixed spaces and uppercase characters in multiline prompt input.

    1.5.0release notes

  • Removes indent when withGuide is set to false.

    1.4.0release notes

  • Fixes line wrapping and overflow computation in group multi-select and other list-like prompts.

    1.4.0release notes

  • The autocomplete prompt now respects withGuide: false.

    1.2.0release notes

  • Applies the guide to wrapped multi-line messages in the confirm prompt.

    1.2.0release notes

  • The multiselect prompt now respects withGuide: false.

    1.2.0release notes

  • With directory: true, the path prompt enforces directory-only selection while still allowing directory navigation.

    1.2.0release notes

  • Pressing Enter with an existing directory as initialValue submits that directory instead of the first child option.

    1.2.0release notes

  • Fixes withGuide support in intro, outro, and cancel messages.

    1.1.0release notes

  • Fixes line wrapping behavior in autocomplete.

    1.0.1release notes

  • Autocomplete no longer allows disabled options to be selected.

    1.0.1release notes

  • The path prompt now supports the withGuide option.

    1.0.1release notes

  • Box rendering handles CJK correctly.

    1.0.0release notes

  • Multi-line prompts support wrapped messages.

    1.0.0release notes

  • Hints are now shown for every selected option that has a hint property, rather than only the first option.

    1.0.0release notes

  • Note text is hard-wrapped to the column limit, and a note overflow bug is fixed.

    1.0.0release notes

  • Note rendering handles CJK correctly.

    1.0.0release notes

  • Placeholder rendering in autocomplete is fixed.

    1.0.0release notes

  • Select-key wrapping is fixed.

    1.0.0release notes

  • Multi-line messages and options render correctly in select prompts.

    1.0.0release notes

  • Calling stop on a spinner that has not started is handled.

    1.0.0release notes

  • Destructive ANSI codes are stripped from task log messages.

    1.0.0release notes