Skip to content

jonluca/lookpath

 
 

Repository files navigation

find-bin

npm version npm download Node.js CI CodeQL codecov Maintainability FOSSA Status

To check if the command exists and where the executable file is, WITHOUT using child_process.

npm install find-bin
yarn add find-bin

Example usage

const { lookpath, lookpathSync } = require('find-bin');

const p = await lookpath('bash');
const pSync = lookpathSync('bash');
// "/bin/bash", otherwise "undefined"

Advanced usage

const p = await lookpath('bash', {
    include: ['/home/hiromu/.bin'],
    exclude: ['/mnt'],
});
// include: Do scan also under `~/.bin`
// exclude: Do NOT scan under `/mnt`
const p = await lookpath('bash', {
    includeCommonPaths: true,
});
// includeCommonPaths: Will scan for bash in many common binary directories, not just those specified in PATH
const p = await lookpath('bash', {
    findAll: true,
});
// ["/bin/bash"], an array containing all the bash binaries found in any path
// includeCommonPaths: Will scan for bash in many common binary directories, not just those specified in PATH

Motivation

About

The minimum and most straightforward way to check if command exists and where the executable is, without spawning child_process.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 98.4%
  • JavaScript 1.6%