Package: meeple-cli
meeple-climeeple-cliis a local board game collection manager. Powered byBoardGameGeek.Jump to:Installation|Usage|Completions|Changelog|Roadmap|FAQ|LegalInstallViaHomebrew(Recommended on macOS/Linux)brewtapboldandbrad/tap
brewinstallmeeple-cliViapipx(Recommended on Windows):pipxinstallmeeple-cliViapip:pipinstallmeeple-cliUsage$ 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.Completionsmeeple-clisupports shell completions forbash,zsh, andfish. For
setup, usemeeple completions <SHELL>, or the following instructions:bashAdd the following to~/.bashrc:eval"$(_MEEPLE_COMPLETE=bash_sourcemeeple)"zshAdd the following to~/.zshrc:eval"$(_MEEPLE_COMPLETE=zsh_sourcemeeple)"fishSave the script to~/.config/fish/completions/meeple.fish:_MEEPLE_COMPLETE=fish_sourcemeeple>~/.config/fish/completions/meeple.fishChangelogSee a history of implemented features/changes in theChangelog.RoadmapSee a list of planned features and milestoneshere.FAQWhy local only collections?Currently, theBoardGameGeek Public APIprovides limitedread-onlydata about user Collections and GeekLists.While it istechnicallyfeasible to interface with Collections and GeekLists
via webscrapers or spiders, these approaches would be complex and also violateBoardGameGeek Terms of Service.For now, it is possible to import BGG user collections intomeeple-cliviameeple import.Why does collection import take so long?Currently, theBoardGameGeek Public APIrelies 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
inthis thread.If your request times out, or exceeds the BGG API rate limit, please be patient
and try again later.Why do some items show a weight ofNAwhen 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, readthis thread.Luckily for us, game weights do not often change drastically. In most cases, we
can assume that the weight from yesterday isclose enough.In the future,meeple-cliwill attempt to compensate for this issue automatically by
displaying the last known value by default, if there is one.Where doesmeeple-clistore data?meeple-clistores collection data in~/.meepleand only makes network
connections to retrieve data from the BoardGameGeek API.LegalDisclaimersNeithermeeple-clinor its maintainers are affiliated withBoardGameGeek.Neithermeeple-clinor its maintainers are affiliated withKickstarter,Gamefound, or any other crowdfunding site or
campaign. Links to crowdfunding campaigns surfaced bymeeple-cliare
sourced from Boardgamegeek and are provided for convenience purposes only.
Back campaigns at your own risk.LicenseCopyright (c) 2023 Bradley Wojcik. Released under the MIT License. SeeLICENSEfor details.