2024-09-24 08:56:37 +00:00
|
|
|
|
import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.B9AX-CPi.js";
|
2024-11-12 02:22:17 +00:00
|
|
|
|
const __pageData = JSON.parse('{"title":"QMK CLI Commands","description":"","frontmatter":{},"headers":[],"relativePath":"cli_commands.md","filePath":"cli_commands.md","lastUpdated":null}');
|
2024-05-30 09:01:49 +00:00
|
|
|
|
const _sfc_main = { name: "cli_commands.md" };
|
2024-06-02 02:43:43 +00:00
|
|
|
|
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="qmk-cli-commands" tabindex="-1">QMK CLI Commands <a class="header-anchor" href="#qmk-cli-commands" aria-label="Permalink to "QMK CLI Commands""></a></h1><h1 id="user-commands" tabindex="-1">User Commands <a class="header-anchor" href="#user-commands" aria-label="Permalink to "User Commands""></a></h1><h2 id="qmk-compile" tabindex="-1"><code>qmk compile</code> <a class="header-anchor" href="#qmk-compile" aria-label="Permalink to "`qmk compile`""></a></h2><p>This command allows you to compile firmware from any directory. You can compile JSON exports from <a href="https://config.qmk.fm" target="_blank" rel="noreferrer">https://config.qmk.fm</a>, compile keymaps in the repo, or compile the keyboard in the current working directory.</p><p>This command is directory aware. It will automatically fill in KEYBOARD and/or KEYMAP if you are in a keyboard or keymap directory.</p><p><strong>Usage for Configurator Exports</strong>:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>qmk compile [-c] <configuratorExport.json></span></span></code></pre></div><p><strong>Usage for Keymaps</strong>:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>qmk compile [-c] [-e <var>=<value>] [-j <num_jobs>] -kb <keyboard_name> -km <keymap_name></span></span></code></pre></div><p><strong>Usage in Keyboard Directory</strong>:</p><p>Must be in keyboard directory with a default keymap, or in keymap directory for keyboard, or supply one with <code>--keymap <keymap_name></code></p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>qmk compile</span></span></code></pre></div><p><strong>Usage for building all keyboards that support a specific keymap</strong>:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>qmk compile -kb all -km <keymap_name></span></span></code></pre></div><p><strong>Example</strong>:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>$ qmk config compile.keymap=default</span></span>\n<span class="line"><span>$ cd ~/qmk_firmware/keyboards/planck/rev6</span></span>\n<span class="line"><span>$ qmk compile</span></span>\n<span class="line"><span>Ψ Compiling keymap with make planck/rev6:default</span></span>\n<span class="line"><span>...</span></span></code></pre></div><p>or with optional keymap argument</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>$ cd ~/qmk_firmware/keyboards/clueboard/66/rev4</span></span>\n<span class="line"><span>$ qmk compile -km 66_iso</span></span>\n<span class="line"><span>Ψ Compiling keymap with make clueboard/66/rev4:66_iso</span></span>\n<span class="line"><span>...</span></span></code></pre></div><p>or in keymap directory</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>$ cd ~/qmk_firmware/keyboards/gh60/satan/keymaps/colemak</span></span>\n<span class="line"><span>$ qmk compile</span></span>\n<span class="line"><span>Ψ Compiling keyma
|
2024-05-30 09:01:49 +00:00
|
|
|
|
const _hoisted_297 = [
|
|
|
|
|
|
_hoisted_1
|
|
|
|
|
|
];
|
|
|
|
|
|
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
|
|
|
|
|
return openBlock(), createElementBlock("div", null, _hoisted_297);
|
|
|
|
|
|
}
|
|
|
|
|
|
const cli_commands = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
|
|
|
|
|
export {
|
|
|
|
|
|
__pageData,
|
|
|
|
|
|
cli_commands as default
|
|
|
|
|
|
};
|
