mirror of https://github.com/openai/codex.git synced 2026-04-24 14:45:27 +00:00

Files

Josh McKinney 70b281bb37 docs(keymap): establish long-term keymap documentation

Publish keymap system documentation first so the implementation stack can
be reviewed against explicit behavior and invariants.

This commit adds the keymap system guide, action matrix, default keymap
template, and config/example documentation updates, plus a rollout plan
used to stage the additive refactor and validation work.

2026-02-19 16:23:55 -08:00

934 B

Raw Blame History

Sample configuration

For a full sample configuration, see this documentation.

Keymap snippet

[tui.keymap]
preset = "latest" # currently points to v1 defaults

[tui.keymap.global]
open_transcript = "ctrl-t"
open_external_editor = "ctrl-g"

[tui.keymap.chat]
edit_previous_message = "esc"
confirm_edit_previous_message = "enter"

[tui.keymap.composer]
submit = "enter"
queue = "tab"
toggle_shortcuts = ["?", "shift-?"]

[tui.keymap.pager]
close = ["q", "ctrl-c"]
close_transcript = ["ctrl-t"]

[tui.keymap.list]
accept = "enter"
cancel = "esc"

[tui.keymap.approval]
approve = "y"
decline = ["esc", "n"]

[tui.keymap.onboarding]
quit = ["q", "ctrl-c", "ctrl-d"]

For a complete, commented template: Keymap template: https://github.com/openai/codex/blob/main/docs/default-keymap.toml For precedence, safety invariants, and testing notes, see docs/tui-keymap.md.

934 B Raw Blame History

Sample configuration

Keymap snippet

934 B

Raw Blame History