Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

readme.md

sudo-block Build Status

Block users from running your tool with root permissions.

Install

Install with npm: npm install --save sudo-block

Example

var sudoBlock = require('sudo-block');
sudoBlock('my-module');

When the above file is ran with root permissions it will exit and show an error message telling the user how to fix the problem so they don't have to run it with sudo.

API

sudoBlock(options)

Options is either a string specifying the package name or an object with these keys:

  • packageName: name of the package the error message is printed for
  • message: a custom error message

sudoBlock.isRoot

Boolean indicating whether the current user is root.

License

MIT License • © Sindre Sorhus