Skip to content

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

License

Notifications You must be signed in to change notification settings

derhuerst/cli-on-key

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cli-on-key

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

npm version 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.

About

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

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published