Skip to main content

openajazz

Control AJAZZ keyboards without the Windows app: lighting effects, per-key RGB, key remaps, macros, music sync, sleep and battery. Works over the USB cable or the 2.4G dongle.

the tui lighting tab with a live effect preview

Supported keyboards

Keyboard Wired 2.4G dongle Bluetooth
AK820 Max Plus (tri-mode RGB) yes yes no (the keyboard doesn't expose settings over Bluetooth)

Have another AJAZZ board? Open an issue with the output of openajazz devices and the name of the vendor driver package; most of them share this protocol.

Get it

Pick one:

Web, no install open openajazz.vercel.app in Chrome, Edge or Opera on a computer
pipx / uv pipx install 'openajazz[music]' or uv tool install 'openajazz[music]'
AppImage grab it from releases, chmod +x, run

Linux permissions

Once, so you don't need sudo (the web app needs this too):

openajazz udev --install      # then replug the keyboard or dongle

It only opens the keyboard's settings interface to your user, never the typing one.

Use it

openajazz                          # full-screen TUI
openajazz status                   # battery
openajazz light breathing -c cyan  # effect + colour (openajazz modes lists them)
openajazz lights off               # and `on` brings your lighting back
openajazz custom -a 101010 w=red a=red s=red d=red
openajazz remap capslock esc
openajazz macro f12 +lctrl c -lctrl
openajazz music --background       # lights follow what's playing, terminal can close
openajazz autostart music          # ...and start that at every login
openajazz --help                   # everything else

Coming from ak820ctl? Same commands under the new name; your saved settings and presets move over on first run.

What doesn't work (yet)

  • Bluetooth: plug in the cable or dongle to change settings.
  • Phones: browsers on phones don't support WebHID.
  • Firmware updates and mouse-button assignments aren't supported.

More detail: CHANGELOG · PROTOCOL.md · issues

Credits

Hardware test results, the colour palette, live-frame behaviour and the effect previews come from prasoondev/ajazz-linux (MIT).

MIT licensed. "AJAZZ" and "AK820" are trademarks of their owner, used here only to say what hardware this is for.

Metadata

Release files for openajazz 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openajazz 0.4.0
File Size Uploaded Provenance
openajazz-0.4.0.tar.gz 46.4 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for openajazz 0.4.0
File Interpreter ABI Platform
openajazz-0.4.0-py3-none-any.whl Python 3 none any Details

Total release size: 91.2 kB

Release files / openajazz-0.4.0.tar.gz

Download URL openajazz-0.4.0.tar.gz
Size 46.4 kB
Tags Source
SHA-256 checksum
How to use checksums
d543501691ce4895fb05baf1c87f85f7cd9e74beb3403eed8857b75a655e6e75
BLAKE2b-256 checksum
How to use checksums
ab8e2599b2b9ec12e8acccea447ebec2dd4360cb4716b02250078ddddb05cb06
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

Release files / openajazz-0.4.0-py3-none-any.whl

Download URL openajazz-0.4.0-py3-none-any.whl
Size 44.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
735b4cc590304dc62bda349482da902a4b28f259cdc1a23445aae5d4303d4f39
BLAKE2b-256 checksum
How to use checksums
d0b5c08d0e923f153084cf5d391ac1b5b23e8dccf26974d6a2fcf6976772394e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

Security for openajazz 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for openajazz-0.4.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 22, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page