Skip to content

alvarocastro/roll-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

roll-cli

NPM Build status Maintainability status Coverage status Code style: XO Release: Semantic

Roll your dices directly from the command line!

It supports the dice notation in the form of AdX, like 1d6 and even simple transforms like 2d10+5, but it also supports more complex rolls like 1d8-1d6/2.

Install

npm install -g @alvarocastro/roll-cli

Usage

$ roll 2d6
7
$ roll 1d6+1d10
12

It can also display detailed information about rolls being made:

$ roll -d 2d6+1d10+3
Rolls:
- 2d6: 2, 5
- 1d10: 8

Result: 18

roll [-d] <dice>

dice

A dice notation string. It supports % for percentile dices (1d% is the same as 1d100). It also supports basic math: +, -, * and /.

Options

-d, --details

Used to output detailed information about the roll. Useful to check doubles, critical hits (or failures)

-v, --version

Displays the current installed version of this utility.

Contributing

Contributions are always welcome! Please run npm test beforehand to ensure everything is ok.

Support

If you use this package please consider starring it :)

Related