it-swarm-eu.dev

Jak vytvořit skript s automatickým dokončováním?

Když používám program typu svn a zadávám terminál Gnome:

svn upd

a zasáhnout Tab je automaticky dokončeno:

svn update

Je možné něco takového udělat v mém vlastním bash skriptu?

132
UAdapter

Můžete použít Programovatelné dokončení . Podívejte se na /etc/bash_completion a /etc/bash_completion.d/* pro některé příklady.

46
Florian Diesch

Mám šest měsíců zpoždění, ale hledal jsem totéž a našel jsem toto:

Budete si muset vytvořit nový soubor:

/etc/bash_completion.d/foo

Pro statické automatické doplňování (--help/--verbose například) přidejte toto:

_foo() 
{
    local cur prev opts
    COMPREPLY=()
    cur="${COMP_WORDS[COMP_CWORD]}"
    prev="${COMP_WORDS[COMP_CWORD-1]}"
    opts="--help --verbose --version"

    if [[ ${cur} == -* ]] ; then
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
    fi
}
complete -F _foo foo
  • COMP_WORDS je pole obsahující všechna jednotlivá slova v aktuálním příkazovém řádku.
  • COMP_CWORD je index Word obsahující aktuální pozici kurzoru.
  • COMPREPLY je proměnná pole, ze které Bash přečte možná dokončení.

Příkaz compgen vrátí pole prvků z --help, --verbose a --version odpovídající aktuálnímu slovu "${cur}":

compgen -W "--help --verbose --version" -- "<userinput>"

Zdroj: https://debian-administration.org/article/316/An_introduction_to_bash_completion_part_1

219
Louis Soulez

Zde je kompletní návod.

Podívejme se na příklad skriptu s názvem admin.sh, na kterém byste chtěli mít automatické doplňování.

#!/bin/bash

while [ $# -gt 0 ]; do
  arg=$1
  case $arg in
    option_1)
     # do_option_1
    ;;
    option_2)
     # do_option_1
    ;;
    shortlist)
      echo option_1 option_2 shortlist
    ;;
    *)
     echo Wrong option
    ;;
  esac
  shift
done

Poznámka: možnost užšího výběru. Volání skriptu s touto volbou vytiskne všechny možné možnosti pro tento skript.

A tady máte skript pro automatické doplňování:

_script()
{
  _script_commands=$(/path/to/your/script.sh shortlist)

  local cur
  COMPREPLY=()
  cur="${COMP_WORDS[COMP_CWORD]}"
  COMPREPLY=( $(compgen -W "${_script_commands}" -- ${cur}) )

  return 0
}
complete -o nospace -F _script ./admin.sh

Posledním argumentem, který má být dokončen, je název skriptu, do kterého chcete přidat automatické doplňování. Vše, co musíte udělat, je přidat svůj autocomplete skript do bashrc jako

source /path/to/your/autocomplete.sh

nebo jej zkopírujte na adresu /etc/bash.completion.d

37
kokosing

Všechna doplnění bash jsou uložena v /etc/bash_completion.d/. Pokud tedy stavíte software s dokončením bash_completion, bylo by užitečné mít v instalačním adresáři soubor s názvem softwaru v tomto adresáři. Zde je příklad skriptu pro dokončení bash pro Rsync:

# bash completion for rsync

have rsync &&
_rsync()
{
    # TODO: _split_longopt

    local cur prev Shell i userhost path   

    COMPREPLY=()
    cur=`_get_cword`
    prev=${COMP_WORDS[COMP_CWORD-1]}

    _expand || return 0

    case "$prev" in
    [email protected](config|password-file|include-from|exclude-from))
        _filedir
        return 0
        ;;
    [email protected](T|-temp-dir|-compare-dest))
        _filedir -d
        return 0
        ;;
    [email protected](e|-rsh))
        COMPREPLY=( $( compgen -W 'rsh ssh' -- "$cur" ) )
        return 0
        ;;
    esac

    case "$cur" in
    -*)
        COMPREPLY=( $( compgen -W '-v -q  -c -a -r -R -b -u -l -L -H \
            -p -o -g -D -t -S -n -W -x -B -e -C -I -T -P \
            -z -h -4 -6 --verbose --quiet --checksum \
            --archive --recursive --relative --backup \
            --backup-dir --suffix= --update --links \
            --copy-links --copy-unsafe-links --safe-links \
            --hard-links --perms --owner --group --devices\
            --times --sparse --dry-run --whole-file \
            --no-whole-file --one-file-system \
            --block-size= --rsh= --rsync-path= \
            --cvs-exclude --existing --ignore-existing \
            --delete --delete-excluded --delete-after \
            --ignore-errors --max-delete= --partial \
            --force --numeric-ids --timeout= \
            --ignore-times --size-only --modify-window= \
            --temp-dir= --compare-dest= --compress \
            --exclude= --exclude-from= --include= \
            --include-from= --version --daemon --no-detach\
            --address= --config= --port= --blocking-io \
            --no-blocking-io --stats --progress \
            --log-format= --password-file= --bwlimit= \
            --write-batch= --read-batch= --help' -- "$cur" ))
        ;;
    *:*)
        # find which remote Shell is used
        Shell=ssh
        for (( i=1; i < COMP_CWORD; i++ )); do
            if [[ "${COMP_WORDS[i]}" == [email protected](e|-rsh) ]]; then
                Shell=${COMP_WORDS[i+1]}
                break
            fi
        done
        if [[ "$Shell" == ssh ]]; then
            # remove backslash escape from :
            cur=${cur/\\:/:}
            userhost=${cur%%?(\\):*}
            path=${cur#*:}
            # unescape spaces
            path=${path//\\\\\\\\ / }
            if [ -z "$path" ]; then
                # default to home dir of specified
                # user on remote Host
                path=$(ssh -o 'Batchmode yes' $userhost pwd 2>/dev/null)
            fi
            # escape spaces; remove executables, aliases, pipes
            # and sockets; add space at end of file names
            COMPREPLY=( $( ssh -o 'Batchmode yes' $userhost \
                command ls -aF1d "$path*" 2>/dev/null | \
                sed -e 's/ /\\\\\\\ /g' -e 's/[*@|=]$//g' \
                -e 's/[^\/]$/& /g' ) )
        fi
        ;;
    *)  
        _known_hosts_real -c -a "$cur"
        _filedir
        ;;
    esac

    return 0
} &&
complete -F _rsync $nospace $filenames rsync

# Local variables:
# mode: Shell-script
# sh-basic-offset: 4
# sh-indent-comment: t
# indent-tabs-mode: nil
# End:
# ex: ts=4 sw=4 et filetype=sh

Pravděpodobně by bylo užitečné zkontrolovat tam jeden ze souborů pro dokončení bash, který nejlépe odpovídá vašemu programu. Jedním z nejjednodušších příkladů je soubor rrdtool.

34
Marco Ceppi

Pokud vše, co potřebujete, je jednoduché automatické dokončování založené na aplikaci Word (takže nedochází k dokončení dílčích příkazů ani nic), má příkaz complete příkaz -W možnost, která jen dělá správnou věc.

Například v mém .bashrc pro automatické doplnění programu s názvem jupyter :

# gleaned from `jupyter --help`
_jupyter_options='console qtconsole notebook' # shortened for this answer
complete -W "${_jupyter_options}" 'jupyter'

Nyní jupyter <TAB> <TAB> autocompletes pro mě.

Užitečné jsou docs na gnu.org.

Zdá se, že se spoléhá na to, že proměnná IFS je nastavena správně, ale to mi nezpůsobilo žádné problémy.

Chcete-li přidat dokončení názvu souboru a výchozí dokončení BASH, použijte -o možnost:

complete -W "${_jupyter_options}" -o bashdefault -o default 'jupyter'

Chcete-li to použít v zsh, přidejte následující kód před spuštěním příkazu complete ve vašem ~/.zshrc:

# make zsh emulate bash if necessary
if [[ -n "$ZSH_VERSION" ]]; then
    autoload bashcompinit
    bashcompinit
fi
14
Ben