<spanclass="line"><span>export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`</span></span>
<spanclass="line"><span>qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment</span></span></code></pre></div><h3id="install-using-easy_install-or-pip"tabindex="-1">Install Using pip <aclass="header-anchor"href="#install-using-easy_install-or-pip"aria-label="Permalink to "Install Using pip {#install-using-easy_install-or-pip}""></a></h3><p>If your system is not listed above you can install QMK manually. First ensure that you have Python 3.7 (or later) installed and have installed pip. Then install QMK with this command:</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>python3 -m pip install qmk</span></span>
<spanclass="line"><span>export QMK_HOME='~/qmk_firmware' # Optional, set the location for `qmk_firmware`</span></span>
<spanclass="line"><span>qmk setup # This will clone `qmk/qmk_firmware` and optionally set up your build environment</span></span></code></pre></div><h3id="packaging-for-other-operating-systems"tabindex="-1">Packaging For Other Operating Systems <aclass="header-anchor"href="#packaging-for-other-operating-systems"aria-label="Permalink to "Packaging For Other Operating Systems {#packaging-for-other-operating-systems}""></a></h3><p>We are looking for people to create and maintain a <code>qmk</code> package for more operating systems. If you would like to create a package for your OS please follow these guidelines:</p><ul><li>Follow best practices for your OS when they conflict with these guidelines <ul><li>Document why in a comment when you do deviate</li></ul></li><li>Install using a virtualenv</li><li>Instruct the user to set the environment variable <code>QMK_HOME</code> to have the firmware source checked out somewhere other than <code>~/qmk_firmware</code>.</li></ul></div></div></main><footerclass="VPDocFooter"data-v-39a288b8data-v-09de1c0f><!--[--><!--]--><!----><navclass="prev-next"data-v-09de1c0f><divclass="pager"data-v-09de1c0f><aclass="VPLink link pager-link prev"href="/configurator_default_keymaps"data-v-09de1c0f><!--[--><spanclass="desc"data-v-09de1c0f>Previous page</span><spanclass="title"data-v-09de1c0f>Adding Default Keymaps</span><!--]--></a></div><divclass="pager"data-v-09de1c0f><aclass="VPLink link pager-link next"href="/cli_configuration"data-v-09de1c0f><!--[--><spanclass="desc"data-v-09de1c0f>Next page</span><spanclass="title"data-v-09de1c0f>Configuration</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
