Skip to content

Add iwctl completion #1616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cladmi wants to merge 3 commits into
base: main
Choose a base branch
from
+1,174 −0
Open

Add iwctl completion #1616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f55f3a
feat(iwctl): Add initial iwctl completion implementation
cladmi Mar 30, 2026
568e54a
test(iwctl): Add mocked output tests.
cladmi Apr 13, 2026
8d0c77f
feat(iwctl): Do not show any completion when not supposed to.
cladmi Apr 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
304 changes: 304 additions & 0 deletions completions-core/iwctl.bash
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,304 @@
# iwctl(1) completion -*- shell-script -*-

# Clean and remove all lines that are not a first column of output.
# @param $1 Column offset. Some values use multiple lines, so only keep lines
# that start at this offset and not more.
_comp_cmd_iwctl__cleanup_output()
{
local offset="$1"
shift
local remove_colors="s/\x1B\[[0-9;]\+m//g"
Copy link
Copy Markdown
Collaborator

@akinomyoga akinomyoga Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
local remove_colors="s/\x1B\[[0-9;]\+m//g"
local remove_colors="s/\x1B\[[0-9:;]\{1,\}m//g"
  • \+ is a GNU extension.
  • SGR may also contain :.

local remove_header_lines="1,4d"
local remove_line_selector_indication="s/^ > / /"
local keep_columns_lines="/^ \{${offset}\}[^ ]/!d"
local format_lstrip="s/^ *\([^ ]\)/\1/"
command sed \
-e "${remove_colors}" \
-e "${remove_header_lines}" \
-e "${remove_line_selector_indication}" \
-e "${keep_columns_lines}" \
-e "${format_lstrip}" \
"$@"
}

# Extract first column when it has no spaces
_comp_cmd_iwctl__filter_first_column()
{
local format_column="s/^\([^ ]\+\) \+.*/\1/g"
_comp_cmd_iwctl__cleanup_output \
2 \
-e "${format_column}"
}

# Extract SSIDs from 'station list' or 'known-networks list'.
# SSIDs have a maximum of 32 characters, and no leading/trailing spaces.
# @param $1 Column offset. See _comp_cmd_iwctl__cleanup_output.
_comp_cmd_iwctl__filter_list_networks()
{
local offset="$1"
shift
local format_network="s/^\(.\{32\}\) .*/\1/"
local format_rstrip="s/\([^ ]\) *$/\1/g"
Copy link
Copy Markdown
Collaborator

@akinomyoga akinomyoga Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
local format_rstrip="s/\([^ ]\) *$/\1/g"
local format_rstrip="s/ *$//"

_comp_cmd_iwctl__cleanup_output \
"${offset}" \
-e "${format_network}" \
-e "${format_rstrip}"
}

# List devices for given device mode.
# @param $1 iwctl binary.
# @param $2 device mode.
_comp_cmd_iwctl__list_devices()
{
local iwctl="$1"
local device_mode="$2"
"${iwctl}" "${device_mode}" list | _comp_cmd_iwctl__filter_first_column
}
Copy link
Copy Markdown
Collaborator

@akinomyoga akinomyoga Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This function is called only in the following form.

                    _comp_compgen_split -l -- \
                        "$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"

Then, shouldn't the entire _comp_compgen_split ... be made a function instead of only making the command-substitution part a function?

Also, _comp_compgen -a -- -W "list" can be included.


_comp_cmd_iwctl__doublequote_compreply_if_has_space()
{
local i
for i in "${!COMPREPLY[@]}"; do
COMPREPLY[i]=${COMPREPLY[i]//* */\"${COMPREPLY[i]}\"}
Copy link
Copy Markdown
Collaborator

@akinomyoga akinomyoga Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
COMPREPLY[i]=${COMPREPLY[i]//* */\"${COMPREPLY[i]}\"}
COMPREPLY[i]=${COMPREPLY[i]//* */\""${COMPREPLY[i]}"\"}

See the description here. Even if you know that & will never be included in the values in this context, it is unclear just by looking at the line, so it's not readable.

done
}

_comp_cmd_iwctl()
{
local cur prev words cword comp_args was_split
# No split on ':' for "connect-hidden" address.
_comp_initialize -n ":" -s -- "$@" || return
local prevprev=${words[cword - 2]}
local prevprevprev=${words[cword - 3]}

case $prev in
--username | --password | --passphrase)
return
;;
esac

# 'subcmd' can be either 'list' or the command after the 'device' name.
local subcword cmd="" has_cmd="" subcmd=""
for ((subcword = 1; subcword < cword; subcword++)); do
[[ $subcmd == list ]] && break
[[ $subcmd ]] && subcmd=${words[subcword]} && break
Comment on lines +83 to +84
Copy link
Copy Markdown
Collaborator

@akinomyoga akinomyoga Apr 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In what situation does subcmd become non-empty in this context? In this loop, subcmd is set only by line 85, but that line performs break, so isn't subcmd inside the loop always empty?

[[ $has_cmd ]] && subcmd=${words[subcword]} && break
[[ ${words[subcword]} != --* &&
${words[subcword - 1]} != --@(username|password|passphrase) ]] &&
cmd=${words[subcword]} has_cmd=set
done

if [[ ! $has_cmd ]]; then
case $cur in
-*)
_comp_compgen_split -- \
"--username --password --passphrase --dont-ask --help"
;;
*)
_comp_compgen_split -- \
"adapter ad-hoc ap device known-networks wsc station dpp pkex debug"
;;
esac
return
fi

case $cmd in
adapter)
[[ $subcmd == list ]] && return
case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"
_comp_compgen -a -- -W "list"
;;
show) ;;
set-property)
# No handling of properties completion.
;;
*)
[[ ${prevprev} == set-property ]] && return
[[ ${prevprevprev} == set-property ]] && return
_comp_compgen_split -- "show set-property"
;;
esac
;;
ad-hoc)
[[ $subcmd == list ]] && return
case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"
_comp_compgen -a -- -W "list"
;;
start | start_open | stop) ;;
*)
_comp_compgen_split -- "start start_open stop"
;;
esac
;;
ap)
[[ $subcmd == list ]] && return
case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"
_comp_compgen -a -- -W "list"
;;
start | start-profile | stop | show | scan | get-networks) ;;
*)
_comp_compgen_split -- \
"start start-profile stop show scan get-networks"
;;
esac
;;
device)
[[ $subcmd == list ]] && return
case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"
_comp_compgen -a -- -W "list"
;;
show) ;;
set-property)
# No handling of properties completion.
;;
*)
[[ ${prevprev} == set-property ]] && return
[[ ${prevprevprev} == set-property ]] && return
_comp_compgen_split -- "show set-property"
;;
esac
;;
known-networks)
[[ $subcmd == list ]] && return
case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$("$1" "$cmd" list | _comp_cmd_iwctl__filter_list_networks 2)"
_comp_compgen -a -- -W "list"
_comp_cmd_iwctl__doublequote_compreply_if_has_space
;;
forget | show) ;;
set-property)
# No handling of properties completion.
;;
*)
[[ ${prevprev} == set-property ]] && return
[[ ${prevprevprev} == set-property ]] && return
_comp_compgen_split -- "forget show set-property"
;;
esac
;;
wsc)
[[ $subcmd == list ]] && return
case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"
_comp_compgen -a -- -W "list"
;;
push-button | start-user-pin | start-pin | cancel) ;;
*)
[[ ${prevprev} == start-user-pin ]] && return
_comp_compgen_split -- "push-button start-user-pin start-pin cancel"
;;
esac
;;
station)
[[ $subcmd == list ]] && return
# All arguments except $prev and trailing empty argument
local iwctl_args=("${words[@]::${#words[@]}-2}")
Copy link
Copy Markdown
Author

@cladmi cladmi Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I need to call iwctl station wlan0 get-networks so try to get rely on words to get everything except the connect in iwctl station wlan0 connect.

There might be options provided in here, as long as the option are given just after iwctl all this will work well, but if not, I know this might break but not sure what would be the correct way of handling it. I thought about generating a whole new array with options removed, but was not sure if it it was necessary to add it, or if there was already a preferred way of handling it.

case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"
_comp_compgen -a -- -W "list"
;;
connect-hidden)
# Quote all completions as it does not keep suggesting the
# completion anymore if it was half-provided.
# It duplicates the completion and then gets obviously stuck.
_comp_compgen_split -l -P '"' -S '"' -- \
"$("${iwctl_args[@]}" get-hidden-access-points | _comp_cmd_iwctl__filter_first_column)"
;;
connect | get-bsses)
_comp_compgen_split -l -- \
"$("${iwctl_args[@]}" get-networks | _comp_cmd_iwctl__filter_list_networks 6)"
_comp_cmd_iwctl__doublequote_compreply_if_has_space
;;
get-networks | get-hidden-access-points)
_comp_compgen_split -- "rssi-dbms rssi-bars"
;;
disconnect | scan | show) ;;
rssi-dbms | rssi-bars)
# get-networks | get-hidden-access-points rssi-dbms | rssi-bars
;;
*)
[[ ${prevprev} == @(connect|connect-hidden|get-bsses) ]] && return
[[ ${prevprevprev} == @(connect|connect-hidden|get-bsses) ]] && return
_comp_compgen_split -- \
"connect connect-hidden disconnect get-networks get-hidden-access-points scan show get-bsses"
;;
esac
;;
dpp)
[[ $subcmd == list ]] && return
case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"
_comp_compgen -a -- -W "list"
;;
start-enrollee | start-configurator | stop | show) ;;
*)
_comp_compgen_split -- \
"start-enrollee start-configurator stop show"
;;
esac
;;
pkex)
[[ $subcmd == list ]] && return
case $prev in
"$cmd")
_comp_compgen_split -l -- \
"$(_comp_cmd_iwctl__list_devices "$1" "$cmd")"
_comp_compgen -a -- -W "list"
;;
enroll | configure)
_comp_compgen_split -- "key"
;;
stop | show) ;;
key)
# enroll|configure key
;;
*)
[[ ${prevprev} == key ]] && return
_comp_compgen_split -- "stop show enroll configure"
;;
esac
;;
debug)
case $prev in
"$cmd")
_comp_compgen_split -- \
"$(_comp_cmd_iwctl__list_devices "$1" station)"
;;
connect | roam)
# Not implemented
;;
autoconnect)
_comp_compgen_split -- "on off"
;;
on | off)
# autoconnect on|off
;;
*)
[[ ${prevprev} == @(connect|roam) ]] && return
_comp_compgen_split -- "connect roam get-networks autoconnect"
;;
esac
;;
esac
} &&
complete -F _comp_cmd_iwctl iwctl
Loading