fzf inspired fuzzy CLI list selection 🎀
npm install -g node-fzf
# by default (TTY mode) will glob list of current dir files
nfzf
# using pipes
find . | nfzf | xargs cat | less
mpv "`find ~/Dropbox/music | nfzf --exact --keep-right`" --no-audio-display
alias merge="git branch | nfzf | xargs git merge"
alias checkout="git branch | nfzf | xargs git checkout"const nfzf = require( 'node-fzf' )
// if you only care about r.query
// nfzf.getInput( label )
const opts = {
/* required */
list: [ 'whale', 'giraffe', 'monkey' ],
/* (optional) */
// filtering mode (user can change modes by pressing ctrl-s)
mode: 'fuzzy' || 'normal',
/* (optional) */
// prefill user input
query: '',
/* (optional) */
// If there is only one match for the initial query (--query), do not
// start interactive finder and automatically select the only match
selectOne: false,
/* (optional) */
// % of screen to use to display results (minimum/defaults to 6 rows)
height: 0, // ex: 40 for 40%, 100 for 100%
/* (optional) */
// text before each displayed line, list index supplied as arg
prelinehook: function ( index ) { return '' },
/* (optional) */
// text after each displayed line, list index supplied as arg
postlinehook: function ( index ) { return '' }
}
;( async function () {
// opens interactive selection CLI
// note! this messes with stdout so if you are
// writing to stdout at the same time it will look a bit messy..
const result = await nfzf( opts )
const { selected, query } = result
if( !selected ) {
console.log( 'No matches for:', query )
} else {
console.log( selected.value ) // 'giraffe'
console.log( selected.index ) // 1
console.log( selected.value === opts.list[ selected.index ] ) // true
}
} )()
// can also add more items later..
setInterval( function () {
opts.list.push( 'foobar' )
// an .update method has been attached to the object/array
// that you gave to nfzf( ... )
opts.update( list )
}, 1000 )const nfzf = require( 'node-fzf' )
// if you only care about r.query
// nfzf.getInput( label, callback )
const list = [ 'whale', 'giraffe', 'monkey' ]
// opens interactive selection CLI
// note! this messes with stdout so if you are
// writing to stdout at the same time it will look a bit messy..
const api = nfzf( list, function ( result ) {
const { selected, query } = result
if( !selected ) {
console.log( 'No matches for:', query )
} else {
console.log( selected.value ) // 'giraffe'
console.log( selected.index ) // 1
console.log( selected.value === list[ selected.index ] ) // true
// the api is a reference to the same argument0 object
// with an added .update method attached.
console.log( list === api ) // true
console.log( list.update === api.update ) // true
}
} )
// can also add more items later..
setInterval( function () {
list.push( 'foobar' )
api.update( list )
}, 1000 )<ctrl-s> switch between search modes (fuzzy, normal/exact)
<ctrl-j>,<ctrl-n>,down scroll down
<ctrl-k>,<ctrl-p>,up scroll up
<ctrl-d> scroll down by page size
<ctrl-u> scroll up by page size
<ctrl-a> jump to start of input
<ctrl-e> jump to end of input (and toggles --keep-right)
<esc>,<ctrl-q>,<ctrl-c> cancel
<return>,<ctrl-m> trigger callback/promise with current selection and exit
<ctrl-w> delete last word from input
<ctrl-b> jump back a word
<ctrl-f> jump forward a word
<backspace> delete last input characterfzf inspired fuzzy CLI list selection thing for node.
easy fuzzy list selection UI for NodeJS CLI programs.
Mostly cli-color for dealing with the terminal rendering and ttys to hack the ttys to simultaneously read from non TTY stdin and read key inputs from TTY stdin -> So that we can get piped input while also at the same time receive and handle raw keyboard input.
fzf even though it doesn't work in NodeJS directly is all-in-all a better tool than this piece of crap :) Highly recommend~
ipt - similar node based solution
npm test