completionsコマンド

completionsコマンドは、よく使われるシェル向けの自動補完を生成します。シェルでmdbookを入力した後に、シェルの自動補完キー(通常はTabキー)を押すと、有効なオプションを表示したり、途中まで入力した内容を補完したりできます。

最初に、利用するシェルへ補完をインストールする必要があります。

# bash
mdbook completions bash > ~/.local/share/bash-completion/completions/mdbook
# oh-my-zsh
mdbook completions zsh > ~/.oh-my-zsh/completions/_mdbook
autoload -U compinit && compinit

このコマンドは、指定したシェル用の補完スクリプトを出力します。対応するシェルの一覧は、mdbook completions --helpで確認できます。

補完を配置する場所は、利用するシェルとOSによって異なります。スクリプトの配置先については、シェルの文書を参照してください。