zmk-workspace

This repository is a workspace for building ZMK firmware, based on urob's zmk-config.

Difference from urob's zmk-config:

• zmk-config can also be in subdirectory of config/ (while config/ is still supported). This enables you to have multiple zmk-configs.
• Supports extra modules for zmk-config and tests
• Dev Container support
• Tab completion for just build and just flash with fzf
• just flash is added for UF2 loader (Only works on WSL with Nix, and requires PowerShell installed on the host machine)
• Automatically removes .west before just init

Note

keymap-drawer is not compatible with this setup.

Usage

Local build environment

Important

On Windows, it is recommended that the workspace be located on WSL-native location (outside of /mnt/c/). Syncing the directory between Windows and WSL / container will result in significantly slower builds.

1. Clone this repo (use --recursive to also clone submodules)
2. See VSCode Docs for Dev Conainer usage. Or, see urob's zmk-config README for Nix and direnv setup
3. git clone your zmk-config into config

   cd config
   git clone https://github.com/your-username/zmk-config-your-keyboard
   cd ..

4. Init and select the target config

   just init config/zmk-config-your-keyboard

   Or if you prefer to treat zmk-workspace as the root of your zmk-config,

   just init config

   You can omit the config name to use fzf to select the config.
5. Build

   just build [target]

6. Flash

   just flash [target]

   or you can specify -r to build before flashing

   just flash [target] -r

Tab completion

With Dev Container or nix develop command, tab completion is enabled by default.

Otherwise, manually run source _just_completion.bash on Zsh to enable tab completion.

source _just_completion.bash