diff options
Diffstat (limited to 'docs/cli.md')
-rw-r--r-- | docs/cli.md | 49 |
1 files changed, 48 insertions, 1 deletions
diff --git a/docs/cli.md b/docs/cli.md index 4f328a75a..f1c158af4 100644 --- a/docs/cli.md +++ b/docs/cli.md | |||
@@ -81,7 +81,7 @@ qmk cformat [file1] [file2] [...] [fileN] | |||
81 | 81 | ||
82 | ## `qmk compile` | 82 | ## `qmk compile` |
83 | 83 | ||
84 | This 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. | 84 | This command allows you to compile firmware from any directory. You can compile JSON exports from <https://config.qmk.fm>, compile keymaps in the repo, or compile the keyboard in the current working directory. |
85 | 85 | ||
86 | **Usage for Configurator Exports**: | 86 | **Usage for Configurator Exports**: |
87 | 87 | ||
@@ -95,6 +95,53 @@ qmk compile <configuratorExport.json> | |||
95 | qmk compile -kb <keyboard_name> -km <keymap_name> | 95 | qmk compile -kb <keyboard_name> -km <keymap_name> |
96 | ``` | 96 | ``` |
97 | 97 | ||
98 | **Usage in Keyboard Directory**: | ||
99 | |||
100 | Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with `--keymap <keymap_name>` | ||
101 | ``` | ||
102 | qmk compile | ||
103 | ``` | ||
104 | |||
105 | **Example**: | ||
106 | ``` | ||
107 | $ qmk config compile.keymap=default | ||
108 | $ cd ~/qmk_firmware/keyboards/planck/rev6 | ||
109 | $ qmk compile | ||
110 | Ψ Compiling keymap with make planck/rev6:default | ||
111 | ... | ||
112 | ``` | ||
113 | or with optional keymap argument | ||
114 | |||
115 | ``` | ||
116 | $ cd ~/qmk_firmware/keyboards/clueboard/66/rev4 | ||
117 | $ qmk compile -km 66_iso | ||
118 | Ψ Compiling keymap with make clueboard/66/rev4:66_iso | ||
119 | ... | ||
120 | ``` | ||
121 | or in keymap directory | ||
122 | |||
123 | ``` | ||
124 | $ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak | ||
125 | $ qmk compile | ||
126 | Ψ Compiling keymap with make make gh60/satan:colemak | ||
127 | ... | ||
128 | ``` | ||
129 | |||
130 | **Usage in Layout Directory**: | ||
131 | |||
132 | Must be under `qmk_firmware/layouts/`, and in a keymap folder. | ||
133 | ``` | ||
134 | qmk compile -kb <keyboard_name> | ||
135 | ``` | ||
136 | |||
137 | **Example**: | ||
138 | ``` | ||
139 | $ cd ~/qmk_firmware/layouts/community/60_ansi/mechmerlin-ansi | ||
140 | $ qmk compile -kb dz60 | ||
141 | Ψ Compiling keymap with make dz60:mechmerlin-ansi | ||
142 | ... | ||
143 | ``` | ||
144 | |||
98 | ## `qmk flash` | 145 | ## `qmk flash` |
99 | 146 | ||
100 | This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. | 147 | This command is similar to `qmk compile`, but can also target a bootloader. The bootloader is optional, and is set to `:flash` by default. |