Git Product home page Git Product logo

gokurakujoudo's Introduction

GokuRakuJoudo

img img

ExamplesTutorialTelegramGoku in the wild

  1. Intro
    1. Why use Goku?
    2. Install
    3. Usage
    4. Tutorial
    5. Note
    6. Changelog
    7. Dependencies
    8. Contributing

Intro

Goku is a tool that lets you manage your Karabiner configuration with ease.

Karabiner Elements uses JSON as its config file format. This leads to thousands of lines of JSON (sometimes over 20,000 lines), which makes it really hard to edit the config file and iterate on your keymap.

But fear not! Goku brings the edn format to the rescue.

Why use Goku?

Below are two Karabiner configuration snippets that map caps lock to an escape key.

karabiner.json

karabiner.edn

In practice this means that you can see multiple Karabiner rules on you screen as you edit your config with Goku. Which speeds up the iteration speed significantly as you can create new rules as little as few characters.

Install

brew install yqrashawn/goku/goku

Usage

Make sure you have a profile named "Default" in Karabiner's GUI tool. You can specify your own profile name using :profiles keyword.

img

Goku reads the karabiner.edn file which holds your Karabiner config. This file should be placed inside ~/.config/ directory on your Mac (you can start with example.edn). Starting from version 0.2.2, you can specify your config file path using the environment variable GOKU_EDN_CONFIG_FILE.

Goku provides two commands:

goku: Will update karabiner.json once. gokuw: Will keep watching your karabiner.edn and when it changes, it will update your karabiner.json configuration.

Run command brew services start goku to use it as a service (runs gokuw in background). When Goku is running as service, the logs are kept inside ~/Library/Logs/goku.log.

Use goku -h to learn more.

Tutorial

Read through the Tutorial about how you can write the configuration in Goku.

If there's any question or advice, just open an issue or join Karabiner Telegram group and ask your questions there.

Note

  • Using #_ to comment out rules like this will leave a null rule (see below) in karabiner.json, it won't cause any error.
    {
      "description" : null,
      "manipulators" : [ ]
    }

Changelog

Check CHANGELOG file.

Dependencies

watchexec for watching the edn config file.
joker for linting the edn config file.

Contributing

Use lein repl for developing.

Change Makefile.local.example's name to Makefile.local, change GRAALVM variable in the makefile to right path, run make local to test then generate goku binary file.

gokurakujoudo's People

Contributors

yqrashawn avatar nikitavoloboev avatar alvaro-prieto avatar seeekr avatar tweoss avatar korniychuk avatar brorbw avatar dylanjm avatar einverne avatar etiennejcharles avatar kiinoda avatar holybasil avatar isaacplmann avatar yomotherboard avatar webappzero avatar kdubovikov avatar konfido avatar narze avatar marcusmoore avatar muhammedzakir avatar nikolai-cc avatar rgomezcasas avatar soenkehahn avatar imgbot[bot] avatar kchen0x avatar shc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.