Valid Keybindings

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.

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": {
    "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"
    }
  },
  "required": [
    "key",
    "command"
  ],
  "title": "Valid Keybinding Entry",
  "type": "object"
}

Required Properties

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.