qmk_firmware/newbs_external_userspace.html

31 lines
107 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>External QMK Userspace | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
<link rel="preload stylesheet" href="/assets/style.No8zk9aC.css" as="style">
<script type="module" src="/assets/app.CBEZK3TQ.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.DyMmIvSC.js">
<link rel="modulepreload" href="/assets/chunks/theme.CkIEWYOL.js">
<link rel="modulepreload" href="/assets/newbs_external_userspace.md.pD9Lc-a5.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec><div class="wrapper" data-v-ccf7ddec><div class="container" data-v-ccf7ddec><div class="title" data-v-ccf7ddec><div class="VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/qmk-logo-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/qmk-logo-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><span data-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></a></div></div><div class="content" data-v-ccf7ddec><div class="content-body" data-v-ccf7ddec><!--[--><!--]--><div class="VPNavBarSearch search" data-v-ccf7ddec><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="./" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://reddit.com/r/olkb" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" width="50px" height="50px"><path d="M 29 3 C 28.0625 3 27.164063 3.382813 26.5 4 C 25.835938 4.617188 25.363281 5.433594 25 6.40625 C 24.355469 8.140625 24.085938 10.394531 24.03125 13.03125 C 19.234375 13.179688 14.820313 14.421875 11.28125 16.46875 C 10.214844 15.46875 8.855469 14.96875 7.5 14.96875 C 6.089844 14.96875 4.675781 15.511719 3.59375 16.59375 C 1.425781 18.761719 1.425781 22.238281 3.59375 24.40625 L 3.84375 24.65625 C 3.3125 26.035156 3 27.488281 3 29 C 3 33.527344 5.566406 37.585938 9.5625 40.4375 C 13.558594 43.289063 19.007813 45 25 45 C 30.992188 45 36.441406 43.289063 40.4375 40.4375 C 44.433594 37.585938 47 33.527344 47 29 C 47 27.488281 46.6875 26.035156 46.15625 24.65625 L 46.40625 24.40625 C 48.574219 22.238281 48.574219 18.761719 46.40625 16.59375 C 45.324219 15.511719 43.910156 14.96875 42.5 14.96875 C 41.144531 14.96875 39.785156 15.46875 38.71875 16.46875 C 35.195313 14.433594 30.800781 13.191406 26.03125 13.03125 C 26.09375 10.546875 26.363281 8.46875 26.875 7.09375 C 27.164063 6.316406 27.527344 5.757813 27.875 5.4375 C 28.222656 5.117188 28.539063 5 29 5 C 29.460938 5 29.683594 5.125 30.03125 5.40625 C 30.378906 5.6875 30.785156 6.148438 31.3125 6.6875 C 32.253906 7.652344 33.695313 8.714844 36.09375 8.9375 C 36.539063 11.238281 38.574219 13 41 13 C 43.75 13 46 10.75 46 8 C 46 5.25 43.75 3 41 3 C 38.605469 3 36.574219 4.710938 36.09375 6.96875 C 34.3125 6.796875 33.527344 6.109375 32.75 5.3125 C 32.300781 4.851563 31.886719
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> clone</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://github.com/{myusername}/qmk_userspace.git</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> config</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> user.overlay_dir=&quot;$(</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">realpath</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> qmk_userspace)&quot;</span></span></code></pre></div><h2 id="external-userspace-setup-locally-stored-only" tabindex="-1">External Userspace Setup (locally stored only) <a class="header-anchor" href="#external-userspace-setup-locally-stored-only" aria-label="Permalink to &quot;External Userspace Setup (locally stored only)&quot;"></a></h2><p>If you don&#39;t want to use GitHub and prefer to keep everything local, you can clone a copy of the default External Userspace locally instead:</p><div class="language-sh vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> $HOME</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> clone</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://github.com/qmk/qmk_userspace.git</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> config</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> user.overlay_dir=&quot;$(</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">realpath</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> qmk_userspace)&quot;</span></span></code></pre></div><h2 id="adding-a-keymap" tabindex="-1">Adding a Keymap <a class="header-anchor" href="#adding-a-keymap" aria-label="Permalink to &quot;Adding a Keymap&quot;"></a></h2><p><em>These instructions assume you have already set up QMK locally, and have a copy of the QMK Firmware repository on your machine.</em></p><p>Keymaps within External Userspace are defined in the same way as they are in the main QMK repository. You can either use the <code>qmk new-keymap</code> command to create a new keymap, or manually create a new directory in the <code>keyboards</code> directory.</p><p>Alternatively, you can use the <code>layouts</code> directory to store your keymaps, using the same layout system as the main QMK repository -- if you choose to do so you&#39;ll want to use the path <code>layouts/&lt;layout name&gt;/&lt;keymap name&gt;/keymap.*</code> to store your keymap files, where <code>layout name</code> matches an existing layout in QMK, such as <code>tkl_ansi</code>.</p><p>After creating your new keymap, building the keymap matches normal QMK usage:</p><div class="language-sh vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> compile</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -kb</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &lt;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">keyboar</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">d</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -km</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &lt;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">keyma</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">p</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&gt;</span></span></code></pre></div><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>The <code>qmk config user.overlay_dir=...</code> command must have been run when cloning the External Userspace repository for this to work correctly.</p></div><h2 id="adding-the-keymap-to-external-userspace-build-targets" tabindex="-1">Adding the keymap to External Userspace build targets <a class="header-anchor" href="#adding-the-keymap-to-external-userspace-build-targets" aria-label="Permalink to &quot;Adding the keymap to External Userspace build targets&quot;"></a></h2><p>Once you have created your keymap, if you want to use GitHub Actions to build your firmware, you will need to add it to the External Userspace build targets. This is done using the <code>qmk userspace-add</code> command:</p><div class="language-sh vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># for a keyboard/keymap combo:</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> userspace-add</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -kb</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &lt;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">keyboar</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">d</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -km</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &lt;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">keyma</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">p</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&gt;</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># or, for a json-based keymap (if kept &quot;loose&quot;):</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> userspace-add</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &lt;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">relative/path/to/my/keymap.jso</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">n</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&gt;</span></span></code></pre></div><p>This updates the <code>qmk.json</code> file in the root of your External Userspace directory. If you&#39;re using a git repository to store your keymaps, now is a great time to commit and push to your own fork.</p><h2 id="compiling-external-userspace-build-targets" tabindex="-1">Compiling External Userspace build targets <a class="header-anchor" href="#compiling-external-userspace-build-targets" aria-label="Permalink to &quot;Compiling External Userspace build targets&quot;"></a></h2><p>Once you have added your keymaps to the External Userspace build targets, you can compile all of them at once using the <code>qmk userspace-compile</code> command:</p><div class="language-sh vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> userspace-compile</span></span></code></pre></div><p>All firmware builds you&#39;ve added to the External Userspace build targets will be built, and the resulting firmware files will be placed in the root of your External Userspace directory.</p><h2 id="using-github-actions" tabindex="-1">Using GitHub Actions <a class="header-anchor" href="#using-github-actions" aria-label="Permalink to &quot;Using GitHub Actions&quot;"></a></h2><p>GitHub Actions can be used to automatically build your keymaps whenever you push changes to your External Userspace repository. If you have set up your list of build targets, this is as simple as enabling workflows in the GitHub repository settings:</p><p><img src="https://i.imgur.com/EVkxOt1.png" alt="Repo Settings"></p><p>Any push will result in compilation of all configured builds, and once completed a new release containing the newly-minted firmware files will be created on GitHub, which you can subsequently download and flash to your keyboard:</p><p><img src="https://i.imgur.com/zmwOL5P.png" alt="Releases"></p></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-09de1c0f><!--[--><!--]--><!----><nav class="prev-next" data-v-09de1c0f><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link prev" href="/support" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Previous page</span><span class="title" data-v-09de1c0f>Getting Help/Support</span><!--]--></a></div><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link next" href="/newbs_learn_more_resources" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Next page</span><span class="title" data-v-09de1c0f>Other Resources</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20200829.md\":\"CoqrOffn\",\"changelog_20210529.md\":\"CR1YNfZX\",\"changelog_20230528.md\":\"nX9R48zP\",\"changelog_20220827.md\":\"DjPthqDk\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"changelog_20210828.md\":\"DNbHIuuM\",\"changelog_20220226.md\":\"BWO5r_ec\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"arm_debugging.md\":\"BH-H2Ukz\",\"capabilities_inc.md\":\"Ca9zpMce\",\"api_development_overview.md\":\"Dcey4ntL\",\"changelog_20240225.md\":\"B4-WrXj6\",\"changelog_20230827.md\":\"NSPhmB6l\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"changelog_20210227.md\":\"BWOtCaeS\",\"changelog_20200229.md\":\"DNsowwM1\",\"cli_development.md\":\"3xFA2OvS\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"changelog_20240526.md\":\"DAmAEDG5\",\"config_options.md\":\"DvMeqlpB\",\"breaking_changes.md\":\"BtdqWQlY\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"cli.md\":\"BLzAdA6l\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"changelog_20221126.md\":\"DpbrnXeC\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"api_docs.md\":\"CRoD6CbL\",\"documentation_templates.md\":\"Bhkum0wD\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"drivers_apa102.md\":\"Qb-KXRpF\",\"drivers_uart.md\":\"BNBs-m3h\",\"configurator_step_by_step.md\":\"CB5U_ksW\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"contributing.md\":\"KzcJdv8r\",\"custom_matrix.md\":\"DMnRw_5l\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"feature_macros.md\":\"By1M5R8G\",\"feature_layouts.md\":\"qcy8hNMO\",\"custom_quantum_functions.md\":\"DrUNiV1i\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"cli_configuration.md\":\"CGSB128P\",\"api_development_environment.md\":\"EhJClb9f\",\"features_audio.md\":\"DWNYte3W\",\"cli_commands.md\":\"DGx-qNiE\",\"capabilities.md\":\"DgKwcj5n\",\"api_overview.md\":\"0FPaUsMb\",\"configurator_architecture.md\":\"DEFTvTlS\",\"data_driven_config.md\":\"BvLQ7P20\",\"drivers_spi.md\":\"tJVeIT7e\",\"easy_maker.md\":\"DAfbIK4w\",\"faq_misc.md\":\"qGrhOTu4\",\"faq_debug.md\":\"DuThValw\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"features_key_overrides.md\":\"rVTP6kn9\",\"faq_general.md\":\"BC3pFw4U\",\"faq_keymap.md\":\"BsEmEZTo\",\"feature_eeprom.md\":\"a0eoTZm7\",\"drivers_audio.md\":\"mqaz6p5N\",\"drivers_adc.md\":\"DzU8txf8\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"drivers_flash.md\":\"DhWcHp8S\",\"drivers_gpio.md\":\"C5PvyJVh\",\"drivers_serial.md\":\"qxjytVdM\",\"features_os_detection.md\":\"DZKTWvSd\",\"features_split_keyboard.md\":\"mMTUzI5n\",\"features_digitizer.md\":\"DGIGZFVx\",\"features_dip_switch.md\":\"DtBOdc98\",\"features_dynamic_macros.md\":\"CrJ1vhBA\",\"features_encoders.md\":\"B2SX3hG2\",\"features_grave_esc.md\":\"mUNEjUYS\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"features_hd44780.md\":\"15K40o_e\",\"features_joystick.md\":\"CW0gZHec\",\"features_key_lock.md\":\"IjFq9dYs\",\"features_st7565.md\":\"MoajNurJ\",\"features_leader_key.md\":\"DBQTnBRh\",\"drivers_eeprom.md\":\"B_6soqar\",\"faq_build.md\":\"DL_WezA1\",\"features_led_matrix.md\":\"D444t5Um\",\"features_led_indicators.md\":\"CCZhjHe9\",\"other_vscode.md\":\"Di3vOySR\",\"platformdev_blackpill_f4x1.md\":\"DvObLRuk\",\"platformdev_chibios_earlyinit.md\":\"BQJSTP3y\",\"keycodes_basic.md\":\"CHIeCvwn\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"platformdev_rp2040.md\":\"CYKYMDfc\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"pr_checklist.md\":\"BnrDXG2G\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"support_deprecation_policy.md\":\"CCo4ljiw\",\"squeezing_avr.md\":\"BmcLYKOr\",\"syllabus.md\":\"B_ARGkLg\",\"feature_userspace.md\":\"BsmY9yWw\",\"features_auto_shift.md\":\"B9HLt3QM\",\"features_bluetooth.md\":\"CiAjl875\",\"features_autocorrect.md\":\"DHRDcuho\",\"features_bootmagic.md\":\"CeNSUsBQ\",\"features_caps_word.md\":\"BDQGM0-x\",\"porting_your_keyboard_to_qmk.md\":\"CGlGdFj4\",\"unit_testing.md\
</body>
</html>