Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@derhuerst/cli-on-key

derhuerst214ISC0.1.0TypeScript support: definitely-typed

Read command line key presses from process.stdin.

command line, cli, key, keypress, stdin, event

readme

cli-on-key

Read command line key presses from process.stdin. Based on TooTallNate/keypress.

npm version build status ISC-licensed chat with me on Gitter support me on Patreon

Installing

npm install @derhuerst/cli-on-key

Usage

listen will switch the stream to raw mode, stopListening will revert to the previous value.

const listen = require('cli-on-key')

const stopListening = listen(process.stdin, (key) => {
    if (key.ctrl && key.name === 'c') {
        stopListening() // stop on Ctrl + C
    } else console.log(key)
})

Contributing

If you have a question or have difficulties using cli-on-key, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to the issues page.