summaryrefslogtreecommitdiff
path: root/lib/python/qmk/cli/list/keyboards.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/cli/list/keyboards.py')
-rw-r--r--lib/python/qmk/cli/list/keyboards.py27
1 files changed, 27 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/list/keyboards.py b/lib/python/qmk/cli/list/keyboards.py
new file mode 100644
index 0000000000..76e7760e84
--- /dev/null
+++ b/lib/python/qmk/cli/list/keyboards.py
@@ -0,0 +1,27 @@
+"""List the keyboards currently defined within QMK
+"""
+import os
+import glob
+
+from milc import cli
+
+BASE_PATH = os.path.join(os.getcwd(), "keyboards") + os.path.sep
+KB_WILDCARD = os.path.join(BASE_PATH, "**", "rules.mk")
+
+
+def find_name(path):
+ """Determine the keyboard name by stripping off the base_path and rules.mk.
+ """
+ return path.replace(BASE_PATH, "").replace(os.path.sep + "rules.mk", "")
+
+
+@cli.subcommand("List the keyboards currently defined within QMK")
+def list_keyboards(cli):
+ """List the keyboards currently defined within QMK
+ """
+ # find everywhere we have rules.mk where keymaps isn't in the path
+ paths = [path for path in glob.iglob(KB_WILDCARD, recursive=True) if 'keymaps' not in path]
+
+ # Extract the keyboard name from the path and print it
+ for keyboard_name in sorted(map(find_name, paths)):
+ print(keyboard_name)