aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorZach White <skullydazed@gmail.com>2021-04-14 19:00:22 -0700
committerGitHub <noreply@github.com>2021-04-14 19:00:22 -0700
commit588bcdc8ca212b195a428fc43766a59a9252c08d (patch)
tree4867ef610b2178d51002063bd4913e806f771543 /docs
parentb33e6793de6c5f5124ee88fb3eb62d8f54f74940 (diff)
downloadqmk_firmware-588bcdc8ca212b195a428fc43766a59a9252c08d.tar.gz
qmk_firmware-588bcdc8ca212b195a428fc43766a59a9252c08d.zip
Add support for tab completion (#12411)
* Add support for tab completion * make flake8 happy * Add documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/_summary.md1
-rw-r--r--docs/cli_tab_complete.md27
2 files changed, 28 insertions, 0 deletions
diff --git a/docs/_summary.md b/docs/_summary.md
index 83799acdb..825514e6b 100644
--- a/docs/_summary.md
+++ b/docs/_summary.md
@@ -29,6 +29,7 @@
29 * [Overview](cli.md) 29 * [Overview](cli.md)
30 * [Configuration](cli_configuration.md) 30 * [Configuration](cli_configuration.md)
31 * [Commands](cli_commands.md) 31 * [Commands](cli_commands.md)
32 * [Tab Completion](cli_tab_complete.md)
32 33
33* Using QMK 34* Using QMK
34 * Guides 35 * Guides
diff --git a/docs/cli_tab_complete.md b/docs/cli_tab_complete.md
new file mode 100644
index 000000000..2217d4fd3
--- /dev/null
+++ b/docs/cli_tab_complete.md
@@ -0,0 +1,27 @@
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 source ~/qmk_firmware/util/qmk_tab_complete.sh
14
15If you put `qmk_firmware` into another location you will need to adjust this path.
16
17### System Wide Symlink
18
19If you want the tab completion available to all users of the system you can add a symlink to the `qmk_tab_complete.sh` script:
20
21 `ln -s ~/qmk_firmware/util/qmk_tab_complete.sh /etc/profile.d/qmk_tab_complete.sh`
22
23### System Wide Copy
24
25In 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.
26
27 cp util/qmk_tab_complete.sh /etc/profile.d