NeilsC / moxcli

Moxfield CLI

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

moxcli

moxcli is a command line interface to Moxfield, the best Magic: The Gathering deck building website around.

It is developed using Ruby.

I welcome any feature requests or bug reports! Please submit an issue here.

Features

Moxcli just has some basic features at the moment. It can output a list of your decks, export the contents of a single (public) deck, or export the contents of all of your decks into text files. See the Usage section below for details.

Installation

Eventually I'd like to make installation easier, but for now there are some manual steps involved.

moxcli requires Ruby to run. It is developed and tested using version 3.1.1. Ruby installation is platform-dependent. Here is a guide to get you started.

Once you have Ruby installed, use git to clone this repository. In the repository folder on your system do the following:

Run bundler to install moxcli dependencies:

$ bundle install

Configure moxcli with your account info:

$ bin/moxcli config

Usage

Output contents of a single deck. You must specify the deck's public ID (you can find this in the deck's Moxfield URL):

$ bin/moxcli get-deck "IzdWDH5u8EOmIeQ8fzriJw"

Output a list of your decks:

$ bin/moxcli list-decks

Export the current contents of all of your decks.

$ bin/moxcli export-decks EXPORT_PATH

export-decks has some options. CAUTION! This will overwrite existing files in the target folder:

$ bin/moxcli export-decks ~/moxfield_decks --overwrite --create-folder

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/neilsc/moxcli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Moxcli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

Moxfield CLI

License:MIT License


Languages

Language:Ruby 99.4%Language:Shell 0.6%