# promptify > An easy-to-use prompt for Node.js. Latest version **2.0.2** (published 2025-02-14) · MIT license · 0 weekly downloads ## Install ```sh npm install promptify pnpm add promptify yarn add promptify bun add promptify ``` ## Health **Score 25/100 (F)** — status: maintenance-mode. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 2.0.2 | | Published | 2025-02-14 | | First published | 2016-11-14 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 14.4 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 1 | | Author | Ionică Bizău | | Maintainers | ionicabizau | | Keywords | promptify, an, easy, to, use, prompt, for, node, js | ## Links - npm: https://www.npmjs.com/package/promptify - Repository: https://github.com/IonicaBizau/promptify - Homepage: https://github.com/IonicaBizau/promptify#readme - Issues: https://github.com/IonicaBizau/promptify/issues - npm.io page: https://npm.io/package/promptify ## Dependencies (2) - [ul](https://npm.io/package/ul.md) ^5.2.9 - [is-win](https://npm.io/package/is-win.md) ^1.0.4 ## Alternatives - [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads - [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads - [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads - [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads - [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads ## Recent versions - 2.0.2 (latest) — 2025-02-14 - 2.0.1 — 2020-08-09 - 2.0.0 — 2019-05-01 - 1.0.1 — 2016-11-15 - 1.0.0 — 2016-11-14 ## README # promptify [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/promptify.svg)](https://www.npmjs.com/package/promptify) [![Downloads](https://img.shields.io/npm/dt/promptify.svg)](https://www.npmjs.com/package/promptify) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/@johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github) Buy Me A Coffee > An easy-to-use prompt for Node.js. ## :cloud: Installation ```sh # Using npm npm install --save promptify # Using yarn yarn add promptify ``` ## :clipboard: Example ```js const promptify = require("promptify"); let name = promptify("Enter your name"); console.log(`Hey, ${name}!`); let pass = promptify("Enter your password", { char: "*" }); console.log(`You entered: ${pass}`); ``` ## :question: Get Help There are few ways to get help: 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question. 2. For bug reports and feature requests, open issues. :bug: 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: ## :memo: Documentation ### `Promptify(conf)` Creates a new `Promptify`. In most of the cases, there will be one such instance per process. #### Params - **Object** `conf`: The `Promptify` config: #### Return - **Promptify** The `Promptify` instance. ### `sync(message, defMsg, options)` Synchronous version of the prompt. #### Params - **String** `message`: The message do display. - **String** `defMsg`: The default value. - **Object** `options`: An object containing the following fields: - `char` (String): The character to display when writing something. For example, if it's `*`, the text characters will be replaced with `*`. - `delimiter` (String): The delimiter between message and the value (default: `": "`). #### Return - **String** The result. ### `promptify()` Prompt a message to the user. The arguments are passed to the `sync` method. ## :yum: How to contribute Have an idea? Found a bug? See [how to contribute][contributing]. ## :sparkling_heart: Support my projects I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it). However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it: - Starring and sharing the projects you like :rocket: - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book: - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone). - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6` ![](https://i.imgur.com/z6OQI95.png) Thanks! :heart: ## :cake: Thanks - Highly inspired from [`prompt-sync`](https://github.com/0x00A/prompt-sync). Thanks! :cake: ## :scroll: License [MIT][license] © [Ionică Bizău][website] [license]: /LICENSE [website]: https://ionicabizau.net [contributing]: /CONTRIBUTING.md [docs]: /DOCUMENTATION.md [badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg [badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg [badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg [badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg [patreon]: https://www.patreon.com/ionicabizau [amazon]: http://amzn.eu/hRo9sIZ [paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW --- _Source: https://npm.io/package/promptify · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._