Selaa lähdekoodia

Shim cli to new keyboard script (#12780)

* Shim cli to new keyboard script

* Shim cli to new keyboard script

* Add docs
Joel Challis 4 vuotta sitten
vanhempi
commit
25c97e0019
3 muutettua tiedostoa jossa 24 lisäystä ja 0 poistoa
  1. 12 0
      docs/cli_commands.md
  2. 1 0
      lib/python/qmk/cli/new/__init__.py
  3. 11 0
      lib/python/qmk/cli/new/keyboard.py

+ 12 - 0
docs/cli_commands.md

@@ -228,6 +228,18 @@ This command is directory aware. It will automatically fill in KEYBOARD if you a
 qmk list-keymaps -kb planck/ez
 ```
 
+## `qmk new-keyboard`
+
+This command creates a new keyboard based on available templates.
+
+This command will prompt for input to guide you though the generation process.
+
+**Usage**:
+
+```
+qmk new-keyboard
+```
+
 ## `qmk new-keymap`
 
 This command creates a new keymap based on a keyboard's existing default keymap.

+ 1 - 0
lib/python/qmk/cli/new/__init__.py

@@ -1 +1,2 @@
+from . import keyboard
 from . import keymap

+ 11 - 0
lib/python/qmk/cli/new/keyboard.py

@@ -0,0 +1,11 @@
+"""This script automates the creation of keyboards.
+"""
+from milc import cli
+
+
+@cli.subcommand('Creates a new keyboard')
+def new_keyboard(cli):
+    """Creates a new keyboard
+    """
+    # TODO: replace this bodge to the existing script
+    cli.run(['util/new_keyboard.sh'], capture_output=False)