summaryrefslogtreecommitdiff
path: root/docs/cli_commands.md
diff options
context:
space:
mode:
authorJoel Challis <git@zvecr.com>2022-07-02 12:50:09 +0100
committerGitHub <noreply@github.com>2022-07-02 21:50:09 +1000
commit59e28b8958db4940f026c4bbd81dee7b9b5e49b0 (patch)
treec9c8ba26fdef7a47e640ee34d22fd1199e0c669e /docs/cli_commands.md
parent9dc7b9d40cfa199875cdc9e2e05b15d3f463b415 (diff)
Add cli command to import keyboard|keymap|kbfirmware (#16668)
Diffstat (limited to 'docs/cli_commands.md')
-rw-r--r--docs/cli_commands.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/docs/cli_commands.md b/docs/cli_commands.md
index a380d3eb2f..56767d962b 100644
--- a/docs/cli_commands.md
+++ b/docs/cli_commands.md
@@ -352,6 +352,73 @@ $ qmk via2json -kb ai03/polaris -o polaris_keymap.json polaris_via_backup.json
352Ψ Wrote keymap to /home/you/qmk_firmware/polaris_keymap.json 352Ψ Wrote keymap to /home/you/qmk_firmware/polaris_keymap.json
353``` 353```
354 354
355## `qmk import-keyboard`
356
357This command imports a data-driven `info.json` keyboard into the repo.
358
359**Usage**:
360
361```
362usage: qmk import-keyboard [-h] filename
363```
364
365**Example:**
366
367```
368$ qmk import-keyboard ~/Downloads/forever60.json
369Ψ Importing forever60.json.
370
371Ψ Imported a new keyboard named forever60.
372Ψ To start working on things, `cd` into keyboards/forever60,
373Ψ or open the directory in your preferred text editor.
374Ψ And build with qmk compile -kb forever60 -km default.
375```
376
377## `qmk import-keymap`
378
379This command imports a data-driven `keymap.json` keymap into the repo.
380
381**Usage**:
382
383```
384usage: qmk import-keymap [-h] filename
385```
386
387**Example:**
388
389```
390qmk import-keymap ~/Downloads/asdf2.json
391Ψ Importing asdf2.json.
392
393Ψ Imported a new keymap named asdf2.
394Ψ To start working on things, `cd` into keyboards/takashicompany/dogtag/keymaps/asdf2,
395Ψ or open the directory in your preferred text editor.
396Ψ And build with qmk compile -kb takashicompany/dogtag -km asdf2.
397```
398
399## `qmk import-kbfirmware`
400
401This command creates a new keyboard based on a [Keyboard Firmware Builder](https://kbfirmware.com/) export.
402
403**Usage**:
404
405```
406usage: qmk import-kbfirmware [-h] filename
407```
408
409**Example:**
410
411```
412$ qmk import-kbfirmware ~/Downloads/gh62.json
413Ψ Importing gh62.json.
414
415⚠ Support here is basic - Consider using 'qmk new-keyboard' instead
416Ψ Imported a new keyboard named gh62.
417Ψ To start working on things, `cd` into keyboards/gh62,
418Ψ or open the directory in your preferred text editor.
419Ψ And build with qmk compile -kb gh62 -km default.
420```
421
355--- 422---
356 423
357# Developer Commands 424# Developer Commands
@@ -527,3 +594,4 @@ This command converts a TTF font to an intermediate format for editing, before c
527## `qmk painter-convert-font-image` 594## `qmk painter-convert-font-image`
528 595
529This command converts an intermediate font image to the QFF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command. 596This command converts an intermediate font image to the QFF File Format. See the [Quantum Painter](quantum_painter.md?id=quantum-painter-cli) documentation for more information on this command.
597