summaryrefslogtreecommitdiffstats
path: root/lib/python/qmk/cli/find.py
diff options
context:
space:
mode:
Diffstat (limited to 'lib/python/qmk/cli/find.py')
-rw-r--r--lib/python/qmk/cli/find.py23
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/python/qmk/cli/find.py b/lib/python/qmk/cli/find.py
new file mode 100644
index 0000000000..b6f74380ab
--- /dev/null
+++ b/lib/python/qmk/cli/find.py
@@ -0,0 +1,23 @@
+"""Command to search through all keyboards and keymaps for a given search criteria.
+"""
+from milc import cli
+from qmk.search import search_keymap_targets
+
+
+@cli.argument(
+ '-f',
+ '--filter',
+ arg_only=True,
+ action='append',
+ default=[],
+ help= # noqa: `format-python` and `pytest` don't agree here.
+ "Filter the list of keyboards based on the supplied value in rules.mk. Matches info.json structure, and accepts the formats 'features.rgblight=true' or 'exists(matrix_pins.direct)'. May be passed multiple times, all filters need to match. Value may include wildcards such as '*' and '?'." # noqa: `format-python` and `pytest` don't agree here.
+)
+@cli.argument('-km', '--keymap', type=str, default='default', help="The keymap name to build. Default is 'default'.")
+@cli.subcommand('Find builds which match supplied search criteria.')
+def find(cli):
+ """Search through all keyboards and keymaps for a given search criteria.
+ """
+ targets = search_keymap_targets(cli.args.keymap, cli.args.filter)
+ for target in targets:
+ print(f'{target[0]}:{target[1]}')