File: fuzzy.rst

package info (click to toggle)
beets 2.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,536 kB
  • sloc: python: 45,608; javascript: 7,997; xml: 334; sh: 261; makefile: 119
file content (24 lines) | stat: -rw-r--r-- 860 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
Fuzzy Search Plugin
===================

The ``fuzzy`` plugin provides a prefixed query that searches your library using
fuzzy pattern matching. This can be useful if you want to find a track with
complicated characters in the title.

First, enable the plugin named ``fuzzy`` (see :ref:`using-plugins`).
You'll then be able to use the ``~`` prefix to use fuzzy matching::

    $ beet ls '~Vareoldur'
    Sigur Rós - Valtari - Varðeldur

Configuration
-------------

To configure the plugin, make a ``fuzzy:`` section in your configuration
file. The available options are:

- **threshold**: The "sensitivity" of the fuzzy match. A value of 1.0 will
  show only perfect matches and a value of 0.0 will match everything.
  Default: 0.7.
- **prefix**: The character used to designate fuzzy queries.
  Default: ``~``, which may need to be escaped in some shells.