<spanclass="line"><span>Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'</span></span></code></pre></div><p>Now I can run <code>qmk compile</code> without specifying my keyboard and keymap each time.</p><h2id="setting-user-defaults"tabindex="-1">Setting User Defaults <aclass="header-anchor"href="#setting-user-defaults"aria-label="Permalink to "Setting User Defaults""></a></h2><p>Sometimes you want to share a setting between multiple commands. For example, multiple commands take the argument <code>--keyboard</code>. Rather than setting this value for every command you can set a user value which will be used by any command that takes that argument.</p><p>Example:</p><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>$ qmk config user.keyboard=clueboard/66/rev4 user.keymap=default</span></span>
<spanclass="line"><span>Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'</span></span></code></pre></div><h1id="cli-documentation-qmk-config"tabindex="-1">CLI Documentation (<code>qmk config</code>) <aclass="header-anchor"href="#cli-documentation-qmk-config"aria-label="Permalink to "CLI Documentation (`qmk config`)""></a></h1><p>The <code>qmk config</code> command is used to interact with the underlying configuration. When run with no argument it shows the current configuration. When arguments are supplied they are assumed to be configuration tokens, which are strings containing no spaces with the following form:</p><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span><subcommand|general|default>[.<key>][=<value>]</span></span></code></pre></div><h2id="setting-configuration-values"tabindex="-1">Setting Configuration Values <aclass="header-anchor"href="#setting-configuration-values"aria-label="Permalink to "Setting Configuration Values""></a></h2><p>You can set configuration values by putting an equal sign (=) into your config key. The key must always be the full <code><section>.<key></code> form.</p><p>Example:</p><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>$ qmk config default.keymap=default</span></span>
<spanclass="line"><span>Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'</span></span></code></pre></div><h2id="reading-configuration-values"tabindex="-1">Reading Configuration Values <aclass="header-anchor"href="#reading-configuration-values"aria-label="Permalink to "Reading Configuration Values""></a></h2><p>You can read configuration values for the entire configuration, a single key, or for an entire section. You can also specify multiple keys to display more than one value.</p><h3id="entire-configuration-example"tabindex="-1">Entire Configuration Example <aclass="header-anchor"href="#entire-configuration-example"aria-label="Permalink to "Entire Configuration Example""></a></h3><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>qmk config</span></span></code></pre></div><h3id="whole-section-example"tabindex="-1">Whole Section Example <aclass="header-anchor"href="#whole-section-example"aria-label="Permalink to "Whole Section Example""></a></h3><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>qmk config compile</span></span></code></pre></div><h3id="single-key-example"tabindex="-1">Single Key Example <aclass="header-anchor"href="#single-key-example"aria-label="Permalink to "Single Key Example""></a></h3><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>qmk config compile.keyboard</span></span></code></pre></div><h3id="multiple-keys-example"tabindex="-1">Multiple Keys Example <aclass="header-anchor"href="#multiple-keys-example"aria-label="Permalink to "Multiple Keys Example""></a></h3><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>qmk config user compile.keyboard compile.keymap</span></span></code></pre></div><h2id="deleting-configuration-values"tabindex="-1">Deleting Configuration Values <aclass="header-anchor"href="#deleting-configuration-values"aria-label="Permalink to "Deleting Configuration Values""></a></h2><p>You can delete a configuration value by setting it to the special string <code>None</code>.</p><p>Example:</p><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>$ qmk config default.keymap=None</span></span>
<spanclass="line"><span>Ψ Wrote configuration to '/Users/example/Library/Application Support/qmk/qmk.ini'</span></span></code></pre></div><h2id="multiple-operations"tabindex="-1">Multiple Operations <aclass="header-anchor"href="#multiple-operations"aria-label="Permalink to "Multiple Operations""></a></h2><p>You can combine multiple read and write operations into a single command. They will be executed and displayed in order:</p><divclass="language- vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang"></span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><span>$ qmk config compile default.keymap=default compile.keymap=None</span></span>
