Skip to content

Commit ee49266

Browse files
committed
docs(config/option): expand use_shortcuts with example and demo GIF
1 parent b26e639 commit ee49266

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/config/option.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,18 @@ Custom rules for committing and bumping. See [customization](../customization/co
3535
- Type: `bool`
3636
- Default: `False`
3737

38-
Show keyboard shortcuts when selecting from a list. Define a `key` for each of your choices to set the key. See [shortcut keys](../customization/config_file.md#shortcut-keys) for more details.
38+
Show keyboard shortcuts when selecting from a list. When enabled, each choice shows a shortcut key; press that key or use the arrow keys to select.
39+
40+
Example:
41+
42+
```toml title="pyproject.toml"
43+
[tool.commitizen]
44+
name = "cz_conventional_commits"
45+
use_shortcuts = true
46+
```
47+
48+
Run `cz commit` to see shortcut keys on each choice.
49+
50+
![Menu with shortcut keys](../images/cli_interactive/shortcut_default.gif)
51+
52+
To customize which key is used for each choice (via the `key` field when using `cz_customize`), see [shortcut keys customization](../customization/config_file.md#shortcut-keys).

0 commit comments

Comments
 (0)