You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/config/option.md
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,4 +35,18 @@ Custom rules for committing and bumping. See [customization](../customization/co
35
35
- Type: `bool`
36
36
- Default: `False`
37
37
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
+

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