Skip to content

mxr keys

Generated from mxr keys --help. After editing crates/daemon/src/cli/, update and review the snapshots with scripts/cargo-test -p mxr --test integration cli_help::, then rebuild site/.

Every keyboard shortcut in the TUI and the web app, from one definition

mxr keys [OPTIONS] [COMMAND]
Subcommand Purpose
explain What a key does, in each client; with –context, what it does there
check Check keys.toml and name everything mxr would ignore in it
set Give an action its own keys in the TUI and the web app, in keys.toml. Writes nothing when a key belongs to another action
reset Give an action back its default keys
single-keys Turn every single-character shortcut on or off (WCAG 2.1.4). Modifier chords such as Mod+k, Escape, Enter and the arrows keep working
help Print this message or the help of the given subcommand(s)
Flag Description
--client <CLIENT> Only this client’s keys [possible values: tui, web]
--context <CONTEXT> Only keys live in this place: a TUI context or web scope, such as todo
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

List every keyboard shortcut in the TUI and the web app from mxr’s one key definition, or ask what a key does in a place. See keybindings.

Terminal window
mxr keys --client tui --context list
mxr keys explain e --context todo
mxr keys check
mxr keys --client web --format json

Check keys.toml and name everything mxr would ignore in it

mxr keys check [OPTIONS] [FILE]
Flag Description
[FILE] The file to check; defaults to keys.toml beside your config
Flag Description
--client <CLIENT> Only this client’s keys [possible values: tui, web]
--context <CONTEXT> Only keys live in this place: a TUI context or web scope, such as todo
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

What a key does, in each client; with –context, what it does there

mxr keys explain [OPTIONS] <KEY>
Flag Description
<KEY> The key as mxr spells it, such as e, g i or Mod+k
Flag Description
--client <CLIENT> Only this client’s keys [possible values: tui, web]
--context <CONTEXT> Only keys live in this place: a TUI context or web scope, such as todo
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Give an action back its default keys

mxr keys reset [OPTIONS] <ACTION>
Flag Description
<ACTION> The action id, such as mail.archive
Flag Description
--dry-run Show the change and any conflict; write nothing
--client <CLIENT> Only this client’s keys [possible values: tui, web]
--context <CONTEXT> Only keys live in this place: a TUI context or web scope, such as todo
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Give an action its own keys in the TUI and the web app, in keys.toml. Writes nothing when a key belongs to another action

mxr keys set [OPTIONS] <ACTION> [KEYS]...
Flag Description
<ACTION> The action id, such as mail.archive; mxr keys lists them
[KEYS] … Its keys, primary first, spelled as mxr keys prints them
Flag Description
--none Leave the action without a key; the palette still runs it
--dry-run Show the change and any conflict; write nothing
--client <CLIENT> Only this client’s keys [possible values: tui, web]
--context <CONTEXT> Only keys live in this place: a TUI context or web scope, such as todo
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help

Turn every single-character shortcut on or off (WCAG 2.1.4). Modifier chords such as Mod+k, Escape, Enter and the arrows keep working

mxr keys single-keys [OPTIONS] <STATE>
Flag Description
<STATE> [possible values: on, off]
Flag Description
--dry-run Show the change; write nothing
--client <CLIENT> Only this client’s keys [possible values: tui, web]
--context <CONTEXT> Only keys live in this place: a TUI context or web scope, such as todo
--format <FORMAT> [possible values: table, json, jsonl, csv, ids]
-h, --help Print help