Getting Started

Installation

Moe requires python 3.9 or greater.

1. The latest release of Moe is available on PyPI

   $ pip install moe
   

2. Ensure everything is working properly.

   $ moe --version
   

Understanding Plugins

Before using Moe, you should understand that most of Moe’s features are provided by various plugins that each contribute a different way of interacting with the music in your library. For example, the edit plugin lets you edit your music, while the add plugin lets you add music to your library. Each of these plugins come with their own set of commands and configuration options.

There also exist external or third-party plugins that extend the functionality of Moe even further. See the third-party plugins docs for more information.

Now what?

The first step is configuring Moe to your liking. To do this, check out the configuration docs.

Note

Moe doesn’t ship with any metadata source connections by default. If you’d like to import metadata from online sources such as Musicbrainz, you’ll have to install a third-party plugin.

Once you’re satisfied with everything, you can start using Moe! For normal users, check out the command-line interface docs to interact with and start adding music to your music library. If you’re a developer, check out the relevant developer docs.

Tip

Starting out, it may be helpful to run Moe in verbose mode (moe -v ...) to get a better of idea of what’s happening behind the scenes when executing various commands.