🎲 Roll

Go Reference Latest Release Go Report Card

A simple Go package and CLI for dice rolling.

⚡ Usage

How to use Roll as a CLI or a library

CLI

Installation via Go or Docker

# Go
go install github.com/brittonhayes/roll/cmd/roll

# Docker
docker run --rm -it ghcr.io/brittonhayes/roll:latest 1d6+2

Using the command line tool

# Run the CLI
Usage: roll <dice>

A simple CLI for dice rolling

Arguments:
  <dice>    Dice to roll +/- modifiers e.g. 'roll 1d6', 'roll 2d12+20', or 'roll 1d20-5'

Flags:
  -h, --help            Show context-sensitive help.
  -v, --verbose         Display verbose log output ($VERBOSE)
  -s, --skip-spinner    Skip loading spinner ($SKIP_SPINNER)

# Roll a D6
roll 1d6

# Roll with modifiers
roll 1d6+2

📺 Preview

asciicast

Package

Using the package

func main() {
	// Create a new d6
	d := roll.NewD6()

	// Roll the die
	fmt.Println("Rolling", d)
	result := d.Roll()

	// Print the result
	fmt.Println(result)
}

GitHub

View Github