summaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
authorRyan <fauxpark@gmail.com>2021-07-31 06:57:40 +1000
committerGitHub <noreply@github.com>2021-07-30 21:57:40 +0100
commitb021c2f2c5890df5335d3dd163167c6fe6213e0d (patch)
tree3d1f645190a819f13d7789a11c55b0706e1d9853 /docs/cli_commands.md
parent770a52542592919e504603152f3a2950875150c9 (diff)
downloadqmk_firmware-b021c2f2c5890df5335d3dd163167c6fe6213e0d.tar.gz
qmk_firmware-b021c2f2c5890df5335d3dd163167c6fe6213e0d.zip
Port new_keyboard.sh to CLI (#13706)
Co-authored-by: Erovia <Erovia@users.noreply.github.com>
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index 314e7448d7..c7468eb5e7 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -280,12 +280,12 @@ qmk list-keymaps -kb planck/ez
This command creates a new keyboard based on available templates.
-This command will prompt for input to guide you though the generation process.
+Any arguments that are not provided will prompt for input. If `-u` is not passed and `user.name` is set in .gitconfig, it will be used as the default username in the prompt.
**Usage**:
```
-qmk new-keyboard
+qmk new-keyboard [-kb KEYBOARD] [-t {avr,ps2avrgb}] -u USERNAME
```
## `qmk new-keymap`