meeple-cli 0.1.0b5

Local board game collection manager. Powered by BoardGameGeek.

meeple-cli

Local board game collection manager. Powered by BoardGameGeek.

Disclaimer: Neither meeple-cli nor its maintainers are affiliated with BoardGameGeek.

Install

Global isolated install via pipx (recommended):

pipx install meeple-cli

Local python environment install:

pip install meeple-cli

Usage

$ meeple --help
Usage: meeple [OPTIONS] COMMAND [ARGS]...

  Local board game collection manager. Powered by BoardGameGeek.

Options:
  -h, --help     Show this message and exit.
  -v, --version  Show the version and exit.

Collection Commands:
  add          Add an item to a collection.
  collections  List all collections.
  delete       Delete a collection.
  drop         Remove an item from a collection.
  find         Search collections for items.
  list         List contents of a collection.
  move         Move an item from one collection to another.
  new          Create a new collection.
  rename       Rename a local collection.
  stats        Print out the details of a collection.
  update       Update local collection data.

BoardGameGeek Commands:
  hot     List current BoardGameGeek trending items.
  info    Print out the details of an item.
  open    Open an item on BoardGameGeek.
  search  Search BoardGameGeek for items.

Other Commands:
  completions  Setup meeple shell completions.

Completions

meeple-cli supports shell completions for bash, zsh, and fish. For setup, use meeple completions <SHELL>, or the following instructions:

bash

Add the following to ~/.bashrc:

eval "$(_MEEPLE_COMPLETE=bash_source meeple)"

zsh

Add the following to ~/.zshrc:

eval "$(_MEEPLE_COMPLETE=zsh_source meeple)"

fish

Save the script to ~/.config/fish/completions/meeple.fish:

_MEEPLE_COMPLETE=fish_source meeple > ~/.config/fish/completions/meeple.fish

Changelog

See a history of implemented features/changes in the Changelog.

Roadmap

See a list of planned features and milestones here.

FAQ

Why local only collections?

Currently, the BoardGameGeek Public API provides limited read-only data about user collections/GeekLists.

While it is technically feasible to interface with GeekLists via webscrapers/spiders, this kind of practice would be both complex and also violate BoardGameGeek Terms of Service.

Where does meeple-cli store data?

meeple-cli stores collection data in ~/.meeple and only makes network connections to retrieve data from the BoardGameGeek API.

License

Copyright (c) 2023 Bradley Wojcik. Released under the MIT License. See LICENSE for details.