Custom key bindings
Settings > General > Key Bindings · Castellum
You can rebind any menu shortcut or message-list key. The bindings live in a small text file, keybindings.json, in your Castellum profile folder. If the file does not exist, every default applies.
1. Open the file
Go to Settings > General > Key Bindings and click Reveal Key Bindings File…. The first time, Castellum writes a starting file for you and shows it in Finder. It never overwrites a file you already have. Open it in any text editor.
2. The format
The starting file has a note, a currentBindings list, and an empty overrides section. currentBindings is a read-only snapshot of every command's key, taken when the file was created; changing it does nothing. Put your changes in overrides, keyed by command id:
{
"version": 1,
"overrides": {
"archive": { "bareKey": "y" },
"forward": { "menuChord": "⌥⌘F" }
}
}
menuChordis a menu shortcut written the way the menus show it: modifier symbols⌃ ⌥ ⇧ ⌘followed by one key, for example⇧⌘Ror⌘⌫.bareKeyis the single key used in the message list. Use exactly one character; a capital letter means Shift plus that letter.- Leave out a field to keep its default. Only these two settings can be changed; go-to chords (
gthen a letter) and menu placement cannot. - Command ids are the names in the
currentBindingslist, such asarchive,reply,snoozeandtoggleFlag.
3. Apply your changes
Castellum reads the file at launch and when you click Reload Key Bindings in the same settings section. It does not watch the file, so save it first, then reload.
4. When something is wrong
A bad entry is skipped, never a crash, and the rest of the file still applies. Castellum reports each problem in its error banner:
- A file that is not valid JSON is ignored entirely, and the built-in bindings are used.
- An unknown command id, or a key it cannot understand, is ignored and that command keeps its default.
- An override that would clash with another command's key is skipped.
To start again, delete keybindings.json and click Reveal Key Bindings File….
See also: Keyboard shortcuts.