Valid Keybinding Entry (entry)
Every valid entry for the keybindings.prs and keybindings.issues configuration
options must have a key and command. When a user presses the key or key
combination in the view where those keys are bound, the dashboard shells out and executes the
command.
To help you identify your custom commands, an additional name property can be supplied to describe it in the help menu.
JSON Schema
Definition
{
"$id": "https://dlvhdr.github.io/gh-dash/configuration/keybindings/entry/schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A keybinding to run a shell command in a view.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/keybindings/entry/",
"properties": {
"builtin": {
"description": "One of gh-dash's builtin commands that will run when you press the key combination\n\nhttps://dlvhdr.github.io/gh-dash/configuration/keybindings/entry/#builtin",
"title": "Builtin Command",
"type": "string"
},
"command": {
"description": "The shell command that runs when you press the key combination.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/keybindings/entry/#command",
"title": "Bound Command",
"type": "string"
},
"key": {
"description": "The combination of keys that trigger the command.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/keybindings/entry/#key",
"title": "Bound Key",
"type": "string"
},
"name": {
"description": "A descriptive name for the command\n\nhttps://dlvhdr.github.io/gh-dash/configuration/keybindings/entry/#name",
"title": "Command name",
"type": "string"
}
},
"required": [
"key"
],
"title": "Valid Keybinding Entry",
"type": "object"
}Required Properties
Command name (name)
To help you identify your custom commands, an additional name property can be supplied to describe it in the help menu.
Bound Key (key)
Specifies one or more keys to bind to the command for an entry.
Bound Command (command)
Specifies the command bound to the key for an entry.
Builtin Command (builtin)
Specifies the builtin command bound to the the key for an entry.
For global actions, the available builtin commands are: up, down, firstLine, lastLine, togglePreview, openGithub, refresh, refreshAll, pageDown, pageUp, nextSection, prevSection, search, copyurl, copyNumber, help, quit.
For PRs, the available builtin commands are: prevSidebarTab, nextSidebarTab, approve, assign, unassign, comment, diff, checkout, close, ready, reopen, merge, update, watchChecks, viewIssues, summaryViewMore.
For Issues, the available builtin commands are: assign, unassign, comment, close, reopen, viewPrs.