Skip to content

keyjitsu v0.10.0-beta.4

Pre-release
Pre-release

Choose a tag to compare

@github-actions github-actions released this 18 Oct 19:17
· 9 commits to master since this release
e4a935a

Changelog

All notable changes to Keyjitsu are documented here. This project follows
Semantic Versioning.

[Unreleased]

[0.10.0-beta.4] - 2026-10-18

Added

  • Add portable ZIP export and restore controls to Settings for moving config,
    saved layouts, firmware-state records, heatmaps and cached Oryx data between
    computers. Restore validates bounded archive contents, preserves conflicting
    local files, mirrors firmware-state recovery copies and applies only during a
    controlled app restart.

Security

  • Keep logs, recordings, signing experiments, symlinks and unrelated data out
    of portable backups; reject path traversal, duplicate paths, oversized
    archives, invalid JSON/config schemas and mismatched firmware-state ids.

[0.10.0-beta.3] - 2026-10-18

Added

  • Bundle ZSA's official Voyager default layout (E5AmY/B495Jd) as the offline
    first-run view when no real keyboard layout has been cached. The fallback is
    display/editing data only and is never selected for automatic flashing.

Changed

  • Make saved firmware layouts discoverable in Settings with direct save and
    restore controls plus a shortcut to the portable Keyjitsu data folder.

[0.10.0-beta.2] - 2026-10-18

Fixed

  • Kept Heatmap ranking values and percentages inside their card at supported
    window widths by sizing the label, intensity bar and combined metric from the
    available row width.
  • Added regression coverage for the Heatmap ranking layout and completed a
    visual smoke pass across every app screen with a physical Voyager connected.

[0.10.0-beta.1] - 2026-10-18

Added

  • Native CI and release archives for macOS, Linux x86_64 and Windows x86_64.
  • Cross-platform Voyager discovery and firmware-target validation, including
    rejection of ambiguous or non-Voyager bootloaders and mismatched MCU images.
  • Regression coverage for safe generated QMK rules.mk assignments.

Changed

  • Updated release dependencies and removed obsolete audit exceptions.
  • Documented that stock Oryx firmware cannot expose enough state for an exact
    readback; Keyjitsu-authored firmware embeds a state marker instead.

Fixed

  • CI failures now propagate through diagnostic log pipelines on every runner.
  • Local builds reject executable or unknown Oryx make rules instead of copying
    them into generated firmware sources.
  • Disconnect and shutdown paths clear transient input/effect state, release RGB
    ownership and report worker panics instead of silently discarding them.

[0.9.14] - 2026-10-08

Changed

  • Layout: when Build & flash is disabled, the publish bar and Settings now
    say why (build or flash running, keyboard not connected, unknown firmware
    state, or which local QMK tools are missing). Keys with an unpublished
    change glow orange on the Layout map, and Review N changes jumps to the
    changed key (click again for the next one; the ▾ list jumps to any change).

Added

  • The keyboard guard now verifies with hidutil itself that the remap really
    applied, instead of trusting a successful exit code (hidutil can return
    success while matching zero devices). It also rechecks every few seconds
    while engaged and tries a silent reapply if the OS drops it.
  • Settings has a "Test the guard" button: a read-only, system-wide listen
    for a few seconds to confirm no key press from the built-in keyboard gets
    through, since hidutil reporting its remap as applied is not proof the
    keyboard is actually silenced (on some Macs the remap reaches the
    keyboard's "Service" HID layer but not a separate raw "Device" layer that
    can still deliver presses). Needs the Input Monitoring permission, asked
    for only when the test runs. The sidebar's guard chip turns into a warning
    if hidutil's own report drifts from what the guard expects.

Changed

  • UI review pass. One shared page header on every page (Layers, Peek, FX
    Studio, Settings), so type and spacing stop drifting. The Live board floats
    centred in the leftover height instead of leaving a dead area. Peek loses a
    duplicated Options heading and an explainer sentence, its pin button is no
    longer styled as a primary action, and the settings card is now Behaviour.
    FX Studio gets a real header, a "whole board" legend for the globe marker,
    one-line usage hints with the stale Tools reference fixed, and a disabled
    Test button with a hover hint instead of a standing caption. Autolayer shows
    an empty state instead of a header-only table.

Added

  • GitHub Actions: every push is built, linted and tested on macOS and the
    dependencies are audited. Each tagged release gets a Keyjitsu.app zip, a CLI
    binary and SHA256SUMS.txt, all built from the tagged source on a GitHub
    runner.
  • SECURITY.md, Dependabot, and README sections on download and verification,
    privacy and network use, and uninstalling.

[0.9.2] - 2026-08-21

Added

  • Update check: keyjitsu asks GitHub for the latest release tag once at
    startup (a toggle in Settings turns this off) and on demand via Check for
    updates
    . A newer version shows as a small badge at the bottom of the
    sidebar and a link in Settings. Nothing is downloaded or installed by itself.
  • The sidebar's bottom shows what is on right now: the keyboard guard and the
    autolayer, next to the optional CPU pill.

Changed

  • The Shortcuts tab is gone from the main menu. It was a reference list of
    common shortcuts, not the keys on your keyboard, and read as if it were. It
    now lives in Settings as a collapsible Shortcut library card.
  • Sidebar polish: rows are painted with left-aligned labels (sub-items used to
    drift right because buttons centre their text), experimental tabs carry a
    small "exp" badge instead of it being part of the name, and the connection
    pill says "No keyboard" with the full hint on hover instead of truncating.

[0.9.1] - 2026-08-21

Added

  • The keyboard guard can no longer lock you out: the built-in keyboard is
    automatically re-enabled around the lock screen (the login window is
    always usable) and re-disabled on unlock, via the system's screen
    lock/unlock notifications.
  • Staged per-key remaps and tap dances now persist across restarts (saved
    per layout, shown as pending) instead of living only in memory until the
    next build.
  • With no keyboard attached, Live shows the last layout from the on-disk
    cache
    (never touching the network), so you can view and plan your layout
    with the board unplugged. On a first run with nothing cached, a short
    plug-in hint replaces the old wall of blank keys.

Fixed

  • A transparent vertical strip could appear between the sidebar and the rest
    of the window while no keyboard was connected: the long connection hint
    inflated the sidebar panel beyond its fixed width. The pill now truncates
    (full text on hover).
  • All tabs now share one panel colour, so the Live tab no longer shows a
    darker band next to the sidebar.

Changed

  • Two internal polish passes: de-duplicated helpers (hex parsing, board
    extent, glow conversion, the layer-switch family list), magic numbers turned
    into named constants (including a peek-sizing value that had drifted),
    dead-code removal, and guard-code cleanup, with no behaviour changes.

[0.9.0] - 2026-07-09

First public beta. Feature-complete for the ZSA Voyager on macOS. The API and
config format may still change before 1.0.

Added

  • GUI (keyjitsu with no args): left-sidebar app with Live, Layers,
    Heatmap, Peek, FX Studio, Shortcuts, Performance, Autolayer and Settings.
  • Live editor: per-key slot rows (tap / hold / double-tap / tap+hold),
    Oryx-style keycode picker (layer options shown by name), per-key glow
    color and on-press effect, then Build & flash with a progress modal
    (phase, progress bar, readable collapsible logs).
  • Local firmware builds: 100% offline, no ZSA login. Fetches your Oryx
    source once (cached), patches the keymap, generates QMK tap dances for
    double-tap / tap+hold (with a comfortable 200 ms tapping term), compiles
    with qmk, flashes over the bootloader.
  • Author layers in-app (no Oryx): add / rename / delete custom layers,
    fill their keys, reach them with a switch key, built into a fresh
    LAYOUT block locally.
  • Profiles: snapshot the whole configuration and switch between setups
    losslessly (sidebar).
  • Heatmap (per-layer / summed, ranking, CSV export), Peek layer
    minimap (transparent, click-through, monitor-positionable, key- or
    chord-bound, optional live combo readout with gesture + timing measurement),
    FX Studio RGB effects incl. a custom step sequencer, Shortcuts
    cheatsheet (~160 entries, categories, your own + hideable built-ins),
    Autolayer (switch by frontmost app), Performance self-CPU sampler.
  • Keyboard guard: disable the Mac's built-in keyboard while the Voyager is
    connected, with a three-layer restore (Drop / signal handler / startup
    self-heal) so it can never be left disabled.
  • CLI: list, status, live, layout, watch, heatmap, layer,
    rgb, status-led, brightness, build-local (--set, --dance,
    --new-layer), flash, guard, overlay, autolayer.
  • Keyjitsu.app bundle (scripts/bundle.sh) with an icon.

Hardened (pre-release review)

  • Config is written atomically and an unreadable config is backed up rather
    than silently wiped.
  • Guard restore only clears its safety marker on success. The CLI guard
    self-heals a stale marker on startup.
  • Firmware feature detection (MOUSEKEY/EXTRAKEY) scans layers and tap dances,
    not just edits. Tap-dance layer actions (LT/TT/DF) emit real layer ops, and a
    corrupt/truncated source download can no longer poison the cache.
  • RGB frames are coalesced at the single HID write point so a slow write
    can't back up the command queue. LEDs and the guard are released on quit.
  • Deleting a custom layer renumbers every layer-switch reference (MO/TO/TG/
    TT/OSL/DF/LT) and per-key override that pointed above it, so no key is
    left pointing at the wrong (or a vanished) layer.
  • The bootloader watcher spawned during a flash is given its own timeout so
    a canceled or timed-out flash can't leak a thread that waits forever.

Known limitations

  • macOS is the primary target (guard / autolayer / peek are macOS-only).
  • The .app is ad-hoc signed. Distributing to other machines needs a
    Developer ID signature + notarization.
  • Tap dances aren't yet supported on user-authored layers.
  • A truly wedged HID write can't be timed out (hidapi limitation).