ansballard / zmk-viewer

cli tool to generate preview images from a zmk .keymap file

ZMK viewer

A work in progress Cli tool to generate preview images from a zmk .keymap file.

Usage

Usage: zmk-viewer generate <keyboard-name>

Generate layout image.

Arguments:
  <keyboard-name>    Keyboard name to fetch layout.

Flags:
  -h, --help           Show context-sensitive help.
  -D, --debug          Enable debug mode

  -f, --file=STRING    ZMK .keymap file
  -t, --transparent    Use a transparent background.
  -o, --output="."     Output directory.

Keyboard name should be the same as in https://config.qmk.fm.

zmk-viewer generate cradio

Will output this image:

You can pass a .keymap file (this one for reference) to generate the layout with bindings

zmk-viewer generate -f ~/zmk-config/config/cradio.keymap cradio

will output an image for each layer: