BOI

This is your command line interface into the Binding of Isaac.

Installation

pip3 install -r requirements.txt
pip3 install -e .

Usage

boi provides useful --help flags to help you discover the CLI by yourself:

boi --help

Usage: boi [OPTIONS] COMMAND [ARGS]...

  boi - Command line interface for discovering Binding of Isaac details

Options:
  --help  Show this message and exit.

Commands:
  item     Get details regarding items
  trinket  Get details regarding trinkets

Formats

Most functions allow specifying different format via the -f or --format flags, e.g.

boi item id 10 --format=json

The supported formats are:

simple: A simple tabular format listing all items.
page: A detailed page on a single item, including its picture. Requires you to select a single item from a list if multiple items are returned from the CLI.
json: JSON structure listing all items to easily be consumed by other applications.

Examples

Some examples of commands you can run:

Listing all items/trinkets

For listing all items:

boi item all

or all trinkets:

boi trinket all

Searching by name or subtitle

You can search by name of the item

boi item search "Brimstone"

or it's subtitle

boi item search "not butter bean"

Searching by item aspects

Searching by certain aspects of the items are also possible (possible search terms have been shamelessly copied from platinumgod), like color:

boi item search "pink"

Acknowledgements

pokedex-cli: A CLI Pokedex. This was the main inspiration (both in spirit and in code) for this project.
platinumgod.co.uk: Used for getting item descriptions and search tags, among others.
bindingofisaacrebirth.gamepedia.com: For getting item information such as images.

CasperKoning/boi

BOI