Goku

goku

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

Detected by goku, gokuw | macOS |github.com

Sync it goku.toml

Sync rules

What travels, what stays, what never leaves

Goku in your home directory Every rule on this page, by file

· ~/.config/karabiner.edn Sync

Only what the catalog names. A directory that syncs brings everything inside it except what is listed as excluded here.

apps/goku.tomlThe file this page is generated from

id = "goku"

name = "Goku"

homepage = "https://github.com/yqrashawn/GokuRakuJoudo"

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

# `goku` runs once, `gokuw` watches the file and regenerates on change; both

# are documented in the README's Usage section. Note that `brew install goku`

# from homebrew-core is an unrelated HTTP load tester — this one installs from

# its own tap, `brew install yqrashawn/goku/goku`.

detect = ["goku", "gokuw"]

platforms = ["macos"]

# src/karabiner_configurator/core.clj, "Return karabiner.edn file location":

# $GOKU_EDN_CONFIG_FILE, else $XDG_CONFIG_HOME/karabiner.edn, else

# $HOME/.config/karabiner.edn. The README says the same twice over — "Goku

# reads the karabiner.edn file… This file should be placed inside ~/.config/

# directory on your Mac" and "starting from version 0.2.2, you can specify your

# config file path using the environment variable GOKU_EDN_CONFIG_FILE".

# That XDG-variable-first, ~/.config-second pair is [configHome]. Goku is

# macOS-only (it drives Karabiner-Elements), so the root has no other platform

# to stand for here; it is written as a root rather than a literal ~/.config

# because goku genuinely reads $XDG_CONFIG_HOME.

paths = ["[configHome]/karabiner.edn"]

# What goku writes is Karabiner-Elements' own file — core.clj sends its output

# to $XDG_CONFIG_HOME/karabiner/karabiner.json — which belongs to that app's

# entry and is regenerated from the .edn above anyway. Its log,

# ~/Library/Logs/goku.log, is outside the path too. So there is nothing inside

# what syncs to carve out.

exclude = []

# karabiner.edn is key mappings written by hand. Goku stores no credential.

secret = []

# Re-read on every `goku` run, and on every file change under `gokuw`.

side_effect = false

# No machine_lines: the whole file is key remappings, layers and application

# rules, which is exactly what a user wants on the next Mac. Application rules

# name bundle identifiers rather than paths on this machine.

Use it with your dotfile manager

Same data, in the shape your tool already reads

Opens Otty and adds this tool to what it syncs

Opens otty://sync/add/goku. Otty ships with this catalog, so the link only has to name the tool — nothing is downloaded.

Every one of these is generated from the same rules as this page.