aboutsummaryrefslogtreecommitdiff
path: root/docs/cli.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/cli.md')
-rw-r--r--docs/cli.md17
1 files changed, 12 insertions, 5 deletions
diff --git a/docs/cli.md b/docs/cli.md
index 0365f2c9c..1843f42cd 100644
--- a/docs/cli.md
+++ b/docs/cli.md
@@ -6,7 +6,8 @@ This page describes how to setup and use the QMK CLI.
6 6
7The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to help you work with QMK: 7The QMK CLI makes building and working with QMK keyboards easier. We have provided a number of commands to help you work with QMK:
8 8
9* `qmk compile-json` 9* `qmk compile`
10* `qmk doctor`
10 11
11# Setup 12# Setup
12 13
@@ -20,12 +21,18 @@ You may want to add this to your `.profile`, `.bash_profile`, `.zsh_profile`, or
20 21
21# Commands 22# Commands
22 23
23## `qmk compile-json` 24## `qmk compile`
24 25
25This command allows you to compile JSON files you have downloaded from <https://config.qmk.fm>. 26This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm> or compile keymaps in the repo.
26 27
27**Usage**: 28**Usage for Configurator Exports**:
28 29
29``` 30```
30qmk compile-json mine.json 31qmk compile <configuratorExport.json>
32```
33
34**Usage for Keymaps**:
35
36```
37qmk compile -kb <keyboard_name> -km <keymap_name>
31``` 38```