meeple-cli is a local board game collection manager. Powered by BoardGameGeek.
Jump to: Installation | Usage | Completions | Changelog | Roadmap | FAQ | Legal
Via Homebrew (Recommended on macOS/Linux)
brew tap boldandbrad/tap
brew install meeple-cli
Via pipx (Recommended on Windows):
pipx install meeple-cli
Via pip
:
pip install meeple-cli
$ 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 items to a collection.
collections List all collections.
delete Delete collections.
drop Drop items 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 new collections.
rename Rename a collection.
stats View collection statistics.
update Update collection data.
BoardGameGeek Commands:
campaigns List active crowdfunding campaigns.
hot List current BoardGameGeek trending items.
import Import BoardGameGeek user collections.
info View item details.
open Open items in the browser.
search Search BoardGameGeek for items.
Other Commands:
completions Setup meeple shell completions.
meeple-cli
supports shell completions for bash
, zsh
, and fish
. For
setup, use meeple completions <SHELL>
, or the following instructions:
See a history of implemented features/changes in the Changelog.
See a list of planned features and milestones here.
Currently, the BoardGameGeek Public API provides limited read-only data about user Collections and GeekLists.
While it is technically feasible to interface with Collections and GeekLists via webscrapers or spiders, these approaches would be complex and also violate BoardGameGeek Terms of Service.
For now, it is possible to import BGG user collections into meeple-cli
via
meeple import
.
Currently, the BoardGameGeek Public API relies on queued jobs to create a snapshot of a user's collection on demand. Depending on the length of the queue or size of your BGG collection, the job may take several minutes or longer to complete. You can read more about this issue in this thread.
If your request times out, or exceeds the BGG API rate limit, please be patient and try again later.
NA
when boardgamegeek.com has a value?This is a known and occasionally recurring bug in the BoardGameGeek database. It usually resolves itself within a day. For more info or additional support, read this thread.
Luckily for us, game weights do not often change drastically. In most cases, we
can assume that the weight from yesterday is close enough.
In the future,
meeple-cli
will attempt to compensate for this issue automatically by
displaying the last known value by default, if there is one.
meeple-cli
store data?meeple-cli
stores collection data in ~/.meeple
and only makes network
connections to retrieve data from the BoardGameGeek API.
meeple-cli
nor its maintainers are affiliated with
BoardGameGeek.meeple-cli
nor its maintainers are affiliated with
Kickstarter,
Gamefound, or any other crowdfunding site or
campaign. Links to crowdfunding campaigns surfaced by meeple-cli
are
sourced from Boardgamegeek and are provided for convenience purposes only.
Back campaigns at your own risk.Copyright (c) 2023 Bradley Wojcik. Released under the MIT License. See LICENSE for details.