bash completion for Chef's knife command (updated for 0.10)

knife.sh

# vim: ft=sh:ts=4:sw=4:autoindent:expandtab:
# Author: Avishai Ish-Shalom <avishai@fewbytes.com>

# We need to specify GNU sed for OS X, BSDs, etc.
if [[ "$(uname -s)" == "Darwin" ]]; then
    SED=gsed
else
    SED=sed
fi

# first argument set the command level
_get_knife_completions() {
    n=$1
    shift
    # first argument is knife, so shift it
    #[ "$1" == "knife" ] && shift
    local opts
    opts="$($@ --help | grep -E '^knife' | cut -f$n -d" " | grep -v -E '[][[:upper:].]+' |grep -v '(options)' | sort -u)"
    _upvar opts "$opts"
    return 0
}

_flatten_knife_command() {
    echo ${words[*]:0:$(( ${#words[*]} -1 ))} | tr ' ' '_'
}
# Check cache file for category in file ( passed as $1 ) and run command if cache is empty
# Designed to be used with _get_knife_completions() and use the opts variables for options
_completion_cache() {
    local flag COMMAND
    local OPTIND=1
    while getopts "c" flag "$@"; do
        case $flag in
        c)
            COMMAND=yes
            ;;
        *)
            ;;
        esac
    done
    shift $(( $OPTIND - 1 ))

    local CACHE_FILE="$1"
    shift
    if [ ! -f "$CACHE_FILE" ]; then
        if [[ "$COMMAND" == "yes" ]]; then
            opts=$( eval $@ 2>/dev/null )
            RET=$?
        else
            $@ 2>/dev/null
            RET=$?
        fi
        if [[ $RET -eq 0 ]]; then
            [ -d "$(dirname "$CACHE_FILE")" ] && echo $opts >"$CACHE_FILE"
        else
            unset opts
        fi
    else
        opts=$(cat "$CACHE_FILE")
    fi
    _upvar opts "$opts"
}

_chef_completion_cache() {
    local CACHE_DIR=${CHEF_HOME:-"$HOME/.chef"}/.completion_cache
    unset C
    local C
    if [[ "$1" == "-c" ]]; then
        C="-c"
        shift
    fi
    CACHE_FILE="$CACHE_DIR/$1"; shift
    _completion_cache $C "$CACHE_FILE" "$@"
    _upvar opts "$opts"
}

_knife() {
    if [[ ${cur} =~ /^-/ ]]; then
        return 0
    fi
    local opts cur prev cword words flattened_knife_command
    _chef_completion_cache knife_commands _get_knife_completions 2 knife
    _get_comp_words_by_ref cur prev cword words
    flattened_knife_command=$(_flatten_knife_command)
    COMPREPLY=()
    case $flattened_knife_command in
    *from_file|from_file_*)
        COMPREPLY=( $(compgen -f -- ${cur} ) )
        return 0
        ;;
    *knife_cookbook_upload|*knife_cookbook_test)
        local chef_repos
        if [[ -z $CHEF_REPOS ]]; then
            CHEF_CONFIG="${CHEF_HOME:-$HOME/.chef}/knife.rb"
            chef_repos=( $( ruby -e "def cookbook_path(*args); args.each{|a| puts a }; end; eval(File.open('$CHEF_CONFIG','r').lines.select{|l| l =~ /cookbook_path/}.first)" ) )
        else
            chef_repos=( ${CHEF_REPOS[@]} )
        fi
        if [[ -n "$chef_repos" ]]; then
            opts=$( ls -1p ${chef_repos[@]} | sort -u | ${SED} -n 's/\/$//p' )
            COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        fi
        ;;
    *knife_data)
        opts="bag"
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
        ;;
    *knife_search)
        _chef_completion_cache -c ${words[0]}_data_bags "${words[0]} data bag list|${SED} -r -e 's/[\"\ ,]//g' -e '/[^0-9A-Za-z._-]+/d'"
        OPTS="node ${opts}"
        COMPREPLY=( $(compgen -W "${OPTS}" -- ${cur}) )
        return 0
        ;;
    *knife_node_show|*knife_node_edit|*knife_node_delete|*knife_tag_*)
        _chef_completion_cache -c ${words[0]}_nodes "${words[0]} node list|${SED} -r -e 's/[\"\ ,]//g' -e '/[^0-9A-Za-z._-]+/d'"
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
        ;;
    *knife_role_edit|*knife_role_show|*knife_role_delete)
        _chef_completion_cache -c ${words[0]}_roles "${words[0]} role list|${SED} -r -e 's/[\"\ ,]//g' -e '/[^0-9A-Za-z._-]+/d'"
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
        ;;
    *knife_data_bag_delete|*knife_data_bag_show|*knife_data_bag_edit)
        _chef_completion_cache -c ${words[0]}_data_bags "${words[0]} data bag list|${SED} -r -e 's/[\"\ ,]//g' -e '/[^0-9A-Za-z._-]+/d'"
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
        ;;
    *knife_data_bag_delete_*|*knife_data_bag_show_*|*knife_data_bag_edit_*)
        _chef_completion_cache -c ${words[0]}_data_bag_$prev "${words[0]} data bag show $prev 2>/dev/null|${SED} -r -e 's/[\"\ ,]//g' -e '/^[^0-9A-Za-z._-]+/d'"
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
        ;;
    *knife_client_list|*knife_client_show|*knife_client_edit)
        _chef_completion_cache -c ${words[0]}_clients "${words[0]} client list|${SED} -r -e 's/[\"\ ,]//g' -e '/[^0-9A-Za-z._-]+/d'"
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
        ;;
    *knife_environment_show|*knife_environment_edit|*knife_environment_delete)
        _chef_completion_cache -c ${words[0]}_environments "${words[0]} environment list|${SED} -r -e 's/[\"\ ,]//g' -e '/[^0-9A-Za-z._-]+/d'"
        COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
        return 0
        ;;
    *)
        case $cword in
        1)
            COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
            return 0
            ;;
        *)
            _chef_completion_cache $flattened_knife_command _get_knife_completions $(( $cword + 1 )) ${words[*]}
            COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
            return 0
            ;;
        esac
        ;;
    esac
    [[ ${#COMPREPLY[@]} -ge 1 ]] && return 0
}
complete -F _knife knife

In case anyone else stumbles upon this, and bash errors out with "_upvar: command not found", you'll want to brew install bash-completion and follow the "caveats" instructions to get full bash completion set up.

Anyone have a 0.11? (this is the first search result for knife bash autocomplete)

I wrote a version-independent knife bash completion file a while ago, now it's in Github repo for everyone to use:

https://github.com/vindimy/dotfiles/blob/master/bash-completion/knife.sh

It even suggests environments, roles, nodes, and other Chef objects that exist on Chef server.

What @vindimy's knife.sh is missing is caching - there's considerable latency with knife contacting chef servers for me. This one's missing expiring that cache, though...

I've tried this and https://github.com/wk8/knife-bash-autocomplete/blob/master/knife_autocomplete.sh the latter works without any issue