auri.ee
keyboard stuff
1# Tab Completion for QMK
2
3If you are using Bash 4.2 or later, Zsh, or FiSH you can enable Tab Completion for the QMK CLI. This will let you tab complete the names of flags, keyboards, files, and other `qmk` options.
4
5## Setup
6
7There are several ways you can setup tab completion.
8
9### For Your User Only
10
11Add this to the end of your `.profile` or `.bashrc`:
12
13```
14source ~/qmk_firmware/util/qmk_tab_complete.sh
15```
16
17If you put `qmk_firmware` into another location you will need to adjust this path.
18
19Zsh users will need to load `bashcompinit`. The following can be added to `~/.zshrc` file:
20
21```
22autoload -Uz bashcompinit && bashcompinit
23```
24
25### System Wide Symlink
26
27If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script:
28
29```
30ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh
31```
32
33### System Wide Copy
34
35In some cases a symlink may not work. Instead you can copy the file directly into place. Be aware that updates to the tab complete script may happen from time to time, you will want to recopy the file periodically.
36
37```
38cp util/qmk_tab_complete.sh /etc/profile.d
39```