Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2026-01-13 11:41:43 +01:00
Code Issues Projects Releases Wiki Activity

Add documentation for completion command

Browse source
This commit is contained in:
Thomas Scholtes 2014-03-02 15:50:23 +01:00
parent 5c7104adb0
commit 25080bd59f
2 changed files with 39 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
beets/ui/completion_base.sh
View file

@ -17,8 +17,8 @@
# Completion for the `beet` command
# =================================
#
# Load this script to complete beets subcommands, global options, and
# subcommand options.
# Load this script to complete beets subcommands, options, and
# queries.
#
# If a beets command is found on the command line it completes filenames and
# the subcommand's options. Otherwise it will complete global options and
@ -41,11 +41,6 @@
# beet ls -f "$tit[TAB]
# beet ls -f "$title
#
# * Complete queries.
#
# beet ls art[TAB]
# beet ls artist:
#
# * Complete plugin commands by dynamically checking which commands are
# available.
#

40
docs/reference/cli.rst
View file

@ -17,9 +17,12 @@ Command-Line Interface
beet COMMAND [ARGS...]
The rest of this document describes the available commands. If you ever need
a quick list of what's available, just type ``beet help`` or ``beet help
COMMAND`` for help with a specific command.
Beets also offers command line completion via the `completion`_
command. The rest of this document describes the available
commands. If you ever need a quick list of what's available, just
type ``beet help`` or ``beet help COMMAND`` for help with a specific
command.
Commands
--------
@ -304,6 +307,37 @@ fields
Show the item and album metadata fields available for use in :doc:`query` and
:doc:`pathformat`. Includes any template fields provided by plugins.
completion
``````````
::
beet completion
Print a shell script that enables command line completion.
The script completes the names of builtin subcommands and (after typing
``-``) options of the given command. Currently, it does not support
plugin commands. If you are using a command that accepts a query, the
script will also complete field names. ::
beet list ar[TAB]
# artist: artist_credit: artist_sort: artpath:
beet list artp[TAB]
beet list artpat\:
Don't worry about the slash in front of the colon: This is a escape
sequence for the shell and won't be seen by beets.
To enable completion in your current shell, run ``eval "$(beet
completion)"``. If you want to use it permanently, load the script from
your shell's rc-file.
Completion is only tested to work on Bash 3.2 and newer. It also
requires the ``bash-completion`` package which is available OSX (through
*homebrew* or *ports*) and Linuxes.
.. _global-flags:
Global Flags