Plugins

Plugins extend beets’ core functionality. They add new commands, fetch additional data during import, provide new metadata sources, and much more. If beets by itself doesn’t do what you want it to, you may just need to enable a plugin—or, if you want to do something new, writing a plugin is easy if you know a little Python.

Using Plugins

To use one of the plugins included with beets (see the rest of this page for a list), just use the plugins option in your config.yaml: file, like so:

plugins: inline convert web

The value for plugins can be a space-separated list of plugin names or a YAML list like [foo, bar]. You can see which plugins are currently enabled by typing beet version.

Each plugin has its own set of options that can be defined in a section bearing its name:

plugins: inline convert web

convert:
    auto: true

Autotagger Extensions

Metadata

Path Formats

  • Inline Plugin: Use Python snippets to customize path format strings.
  • Rewrite Plugin: Substitute values in path formats.
  • The Plugin: Move patterns in path formats (i.e., move “a” and “the” to the end).
  • Bucket Plugin: Group your files into bucket directories that cover different field values ranges.

Interoperability

Miscellaneous

Other Plugins

In addition to the plugins that come with beets, there are several plugins that are maintained by the beets community. To use an external plugin, there are two options for installation:

  • Make sure it’s in the Python path (known as sys.path to developers). This just means the plugin has to be installed on your system (e.g., with a setup.py script or a command like pip or easy_install).
  • Set the pluginpath config variable to point to the directory containing the plugin. (See Configuration.)

Once the plugin is installed, enable it by placing its name on the plugins line in your config file.

Here are a few of the plugins written by the beets community: