Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/derhuerst/prompt-skeleton
A consistent behavior for CLI prompts.
https://github.com/derhuerst/prompt-skeleton
cli prompt
Last synced: 5 days ago
JSON representation
A consistent behavior for CLI prompts.
- Host: GitHub
- URL: https://github.com/derhuerst/prompt-skeleton
- Owner: derhuerst
- License: isc
- Created: 2016-04-06T23:37:27.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-28T19:58:51.000Z (almost 3 years ago)
- Last Synced: 2024-10-25T22:49:14.492Z (18 days ago)
- Topics: cli, prompt
- Language: JavaScript
- Homepage: https://github.com/derhuerst/prompt-skeleton
- Size: 45.9 KB
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# prompt-skeleton
This project aims to bring a **consistent behavior to CLI apps**.
Use [`cli-prompter`](https://github.com/ahdinosaur/cli-prompter) if you want to have batteries included or if you want to chain prompts.
[](https://www.npmjs.com/package/prompt-skeleton)
[](https://david-dm.org/derhuerst/prompt-skeleton#info=dependencies)
[](https://github.com/sponsors/derhuerst)
[](https://twitter.com/derhuerst)
Instead of letting prompts parse user input by themselves, *prompt-skeleton* provides a [standard set of actions like `submit`](#actions), which prompts can act on by exposing methods. The key bindings are [readline](https://de.wikipedia.org/wiki/GNU_readline)-inspired.
## Projects using `prompt-skeleton`
Prompts:
- [`sms-cli`](https://github.com/derhuerst/sms-cli)
- [`date-prompt`](https://github.com/derhuerst/date-prompt)
- [`mail-prompt`](https://github.com/derhuerst/mail-prompt)
- [`multiselect-prompt`](https://github.com/derhuerst/multiselect-prompt)
- [`number-prompt`](https://github.com/derhuerst/number-prompt)
- [`range-prompt`](https://github.com/derhuerst/range-prompt)
- [`select-prompt`](https://github.com/derhuerst/select-prompt)
- [`text-prompt`](https://github.com/derhuerst/text-prompt)
- [`tree-select-prompt`](https://github.com/derhuerst/tree-select-prompt)
- [`cli-autocomplete`](https://github.com/derhuerst/cli-autocomplete)
- [`switch-prompt`](https://github.com/derhuerst/switch-prompt)
Other command line interfaces:
- [`really-basic-chat-ui`](https://github.com/derhuerst/really-basic-chat-ui)
- [`command-irail`](https://github.com/iRail/command-irail)
- [`cli-2048`](https://github.com/derhuerst/cli-2048)
- [`cli-minesweeper`](https://github.com/derhuerst/cli-minesweeper)
- [`tiny-cli-editor`](https://github.com/derhuerst/tiny-cli-editor)
## Installing
```
npm install prompt-skeleton
```
## Usage
```js
wrap(prompt) // Promise
```
To render to screen, [`write`](https://nodejs.org/api/stream.html#stream_writable_write_chunk_encoding_callback) to `prompt.out`. Because `prompt.out` is a [`ansi-diff-stream`](https://www.npmjs.com/package/ansi-diff-stream#usage), you can also clear the screen manually be calling `prompt.out.clear()`.
### Actions
You can process any of these actions by exposing a method `prompt[action]`.
- `first`/`last` – move to the first/last letter/digit
- `left`/`right`
- `up`/`down`
- `next` - for tabbing
- `delete` – remove letter/digit left to the cursor
- `space`
- `submit` – success, close the prompt
- `abort` – failure, close the prompt
- `reset`
### Example
This renders a prompt that lets you pick a number.
```js
const wrap = require('prompt-skeleton')
const prompt = wrap({
value: 0,
up: function () {
this.value++
this.render()
},
down: function () {
this.value--
this.render()
},
render: function () {
this.out.write(`The value is ${this.value}.`)
}
})
prompt
.then((val) => {
// prompt succeeded, do something with the value
})
.catch((val) => {
// prompt aborted, do something with the value
})
```
## Contributing
If you **have a question**, **found a bug** or want to **propose a feature**, have a look at [the issues page](https://github.com/derhuerst/prompt-skeleton/issues).