Kanata

What does this do?

This is a cross-platform software keyboard remapper for Linux, macOS and Windows. A short summary of the features:

• multiple layers of key functionality
• advanced key behaviour customization (e.g. tap-hold, macros, unicode)
• cross-platform human readable configuration file

Check out the examples directory and the online simulator.

To see all of the features, see the configuration guide. The configuration guide aims to be up-to-date with main and may have features not in your version. See the applicable link in the releases page.

The most similar project is kmonad, which served as the inspiration for kanata. Here's a comparison document.

You can see a list of known issues here.

Demo video

Showcase of multi-layer functionality (30s, 1.7 MB).

Why is this useful?

Imagine if, instead of pressing Shift to type uppercase letters, we had giant keyboards with separate keys for lowercase and uppercase letters. I hope we can all agree: that would be a terrible user experience!

A way to think of how Shift keys work is that they switch your input to another layer of functionality where you now type uppercase letters and symbols instead of lowercase letters and numbers.

What kanata allows you to do is take this alternate layer concept that Shift keys have and apply it to any key. You can then customize what those layers do to suit your exact needs and workflows.

Usage

Running kanata currently does not start it in a background process. You will need to keep the window that starts kanata running to keep kanata active. Some tips for running kanata in the background:

• Windows: https://github.com/jtroo/kanata/discussions/193
• Linux: https://github.com/jtroo/kanata/discussions/130
• Run from tray icon: kanata-tray

Pre-built executables

See the releases page for executables and instructions.

Build it yourself

This project uses the latest Rust stable toolchain. If you installed the Rust toolchain using rustup, e.g. by using the instructions from the official website, you can get the latest stable toolchain with rustup update stable.

cargo install kanata

# On Linux and macOS, this may not work without `sudo`, see below
kanata --cfg <your_configuration_file>

git clone https://github.com/jtroo/kanata && cd kanata
cargo build   # --release optional, not really perf sensitive

# sudo is used because kanata opens /dev/ files
#
# See below if you want to avoid needing sudo:
# https://github.com/jtroo/kanata/wiki/Avoid-using-sudo-on-Linux
sudo target/debug/kanata --cfg <your_configuration_file>

git clone https://github.com/jtroo/kanata; cd kanata
cargo build   # --release optional, not really perf sensitive
target\debug\kanata --cfg <your_configuration_file>

git clone https://github.com/jtroo/kanata && cd kanata
cargo build   # --release optional, not really perf sensitive

# sudo is needed to gain permission to intercept the keyboard

sudo target/debug/kanata --cfg <your_configuration_file>

Feature flags

When either building yourself or using cargo install, you can add feature flags that enable functionality that is turned off by default.

cargo build --release --features cmd
cargo install --features cmd

cargo build --release --features interception_driver
cargo install --features interception_driver

cargo build --release --features cmd,interception_driver
cargo install --features cmd,interception_driver

Other installation methods

Notable features

• Human readable configuration file.
  • Minimal example
  • Full guide
  • Simple example with explanations
  • All features showcase
• Live reloading of the configuration for easy testing of your changes.
• Multiple layers of key functionality
• Advanced actions such as tap-hold, unicode output, dynamic and static macros
• Vim-like leader sequences to execute other actions
• Optionally run a TCP server to interact with other programs
  • Other programs can respond to layer changes or trigger layer changes
• Interception driver support (use kanata_wintercept.exe)
  • Note that this issue exists, which is outside the control of this project: https://github.com/oblitum/Interception/issues/25

Contributing

Contributions are welcome!

Unless explicitly stated otherwise, your contributions to kanata will be made under the LGPL-3.0-only* license.

The exception to this is the code under the keyberon directory, which is licensed under the MIT license, and likewise, contributions to code in this directory will be made under the MIT license unless explicitly stated otherwise.

Here's a basic low-effort design doc of kanata

How you can help

• Try it out and let me know what you think. Feel free to file an issue or start a discussion.
• Usability issues and unhelpful error messages are considered bugs that should be fixed. If you encounter any, I would be thankful if you file an issue.
• Browse the open issues and help out if you are able and/or would like to. If you want to try contributing, feel free to ping jtroo for some pointers.
• If you know anything about writing a keyboard driver for Windows, starting an open-source alternative to the Interception driver would be lovely.

Community projects related to kanata

• vscode-kanata: Language support for kanata configuration files in VS Code
• komokana: Automatic application-aware layer switching for komorebi (Windows)
• kanata-tray: Control kanata from a tray icon
• Application-aware layer switching:
  • qanata (Linux)
  • kanawin (Windows)
  • window_tools (Windows)

What does the name mean?

I wanted a "k" word since this relates to keyboards. According to Wikipedia, kanata is an indigenous Iroquoian word meaning "village" or "settlement" and is the origin of Canada's name.

There's also PPT✧.

Motivation

TLDR: QMK features but for any keyboard, not just fancy mechanical ones.

7 8 9
u i o
j k l
m , .

arrows:       numpad:
- - -         7 8 9
- ↑ -         4 5 6
← ↓ →         1 2 3
- - -         0 * .

Similar Projects

• kmonad: The inspiration for kanata (Linux, Windows, Mac)
• QMK: Open source keyboard firmware
• keyberon: Rust #[no_std] library intended for keyboard firmware
• ktrl: Linux-only keyboard customizer with layers, a TCP server, and audio support
• kbremap: Windows-only keyboard customizer with layers and unicode
• xcape: Linux-only tap-hold modifiers
• karabiner-elements: Mac-only keyboard customizer
• capsicain: Windows-only key remapper with driver-level key interception
• keyd: Linux-only key remapper very similar to QMK, kmonad, and kanata
• xremap: Linux-only application-aware key remapper inspired more by Emacs key sequences vs. QMK layers/Vim modes
• keymapper: Context-aware cross-platform key remapper with a different transformation model (Linux, Windows, Mac)

Why the list?

While kanata is the best tool for some, it may not be the best tool for you. I'm happy to introduce you to tools that may better suit your needs. This list is also useful as reference/inspiration for functionality that could be added to kanata.

Donations/Support?

The author (jtroo) will not accept monetary donations for work on kanata. Please instead donate your time and/or money to charity.

Some links are below. These links are provided for learning and as interesting reads. They are not an endorsement.

• https://www.effectivealtruism.org/
• https://www.givewell.org/