Karabiner-Elements

[![Build Status](https://github.com/pqrs-org/Karabiner-Elements/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/pqrs-org/Karabiner-Elements/actions/workflows/ci.yml?query=branch%3Amain)
[![License](https://img.shields.io/badge/license-Public%20Domain-blue.svg)](https://github.com/pqrs-org/Karabiner-Elements/blob/main/LICENSE.md)

# Karabiner-Elements

Karabiner-Elements is a powerful key remapper for macOS.

## Download

You can download Karabiner-Elements from the [official site](https://karabiner-elements.pqrs.org/).

Alternatively, if you use [Homebrew](https://brew.sh/), you can install Karabiner-Elements with `brew install --cask karabiner-elements`.

### Old releases

You can download previous versions of Karabiner-Elements from the [release notes](https://karabiner-elements.pqrs.org/docs/releasenotes/).

## Supported systems

- macOS 27 Golden Gate
    - Apple Silicon Macs
- macOS 26 Tahoe
    - Both Intel-based Macs and Apple Silicon Macs
- macOS 15 Sequoia
    - Both Intel-based Macs and Apple Silicon Macs
- macOS 14 Sonoma
    - Both Intel-based Macs and Apple Silicon Macs
- macOS 13 Ventura
    - Both Intel-based Macs and Apple Silicon Macs

## Usage

Documentation can be found here: <https://karabiner-elements.pqrs.org/docs/>

## Donations

If you would like to support Karabiner-Elements development financially, donations can be made at <https://karabiner-elements.pqrs.org/docs/pricing/>.

## Localization

To edit translations or add a language, see the [localization guide](src/apps/localization/README.md).

---

## For developers

### System requirements to build Karabiner-Elements

- macOS 15+
- Xcode 26+
- Command Line Tools for Xcode (`xcode-select --install`)
- xz (`brew install xz`)
- [XcodeGen](https://github.com/yonaskolb/XcodeGen) (`brew install xcodegen`)
- CMake (`brew install cmake`)

### How to build the package

#### Step 1: Get the source code

Get the source code by running the following commands in Terminal.app.

```shell
git clone --depth 1 https://github.com/pqrs-org/Karabiner-Elements.git
cd Karabiner-Elements
git submodule update --init --recursive --depth 1
```

#### Step 2: Prepare code signing identities

Code signing is required for the Karabiner-Elements background services to run.
Prepare the appropriate code signing identities for your Apple Developer Program status.

- If you are not enrolled in the Apple Developer Program:
    - Use a development code signing identity.
    - In Xcode Settings, add your account under Apple Accounts, then create an Apple Development certificate from Manage Certificates.
- If you are enrolled in the Apple Developer Program:
    - Create Developer ID Application and Developer ID Installer certificates if you do not already have them.

After preparing the code signing identities, run the following command in Terminal.app to get the identity hashes.

```shell
security find-identity -v
```

The output will look like this.
The strings such as `C3107C61DB3605DA