HiveBrain v1.2.0
Get Started
← Back to all entries
snippetbashTip

complete — Get and set argument autocompletion rules of shell commands in Bash. The specified completions will

Submitted by: @import:tldr-pages··
0
Viewed 0 times
clitldrcompletecommand-line
argumentcommandandcliautocompletioncompletesetget

Problem

How to use the complete command: Get and set argument autocompletion rules of shell commands in Bash. The specified completions will be invoked when <Tab> is pressed in Bash. See also: compgen, compopt. More information: <https://www.gnu.org/software/bash/manual/bash.html#index-complete>.

Solution

complete — Get and set argument autocompletion rules of shell commands in Bash. The specified completions will be invoked when <Tab> is pressed in Bash. See also: compgen, compopt. More information: <https://www.gnu.org/software/bash/manual/bash.html#index-complete>.

Set arguments of a command to autocomplete through a function (completion response is sent in $COMPREPLY variable):
complete -F {{function}} {{command}}


Set arguments of a command to autocomplete through another command ($1 is the command, $2 is the argument the cursor is on, and $3 is the argument preceding the cursor):
complete -C {{autocomplete_command}} {{command}}


Set arguments of a command to autocomplete to shell builtins:
complete -b {{command}}


Apply autocompletion without appending a space to the completed word:
complete -o nospace -F {{function}} {{command}}


List all loaded complete specifications:
complete -p


List loaded complete specifications for a command:
complete -p {{command}}

Code Snippets

Set arguments of a command to autocomplete through a function (completion response is sent in `$COMPREPLY` variable)

complete -F {{function}} {{command}}

Set arguments of a command to autocomplete through another command (`$1` is the command, `$2` is the argument the cursor is on, and `$3` is the argument preceding the cursor)

complete -C {{autocomplete_command}} {{command}}

Set arguments of a command to autocomplete to shell builtins

complete -b {{command}}

Apply autocompletion without appending a space to the completed word

complete -o nospace -F {{function}} {{command}}

List all loaded complete specifications

complete -p

Context

tldr-pages: common/complete

Revisions (0)

No revisions yet.