datasette-keyboard-shortcuts

Plugin for configuring keyboard shortcuts for Datasette.

Installation

uv add datasette-keyboard-shortcuts

Configuration

Shortcuts can be configured in datasette.yaml or metadata.json:

plugins:
  datasette-keyboard-shortcuts:
    shortcuts:
      - id: run-query
        key: Mod+Enter
        action: run-query

Default shortcuts

Mod+Enter runs the SQL query on the query page. Shift+Mod+F formats the query using Datasette's built-in Format SQL button. Mod means Command on macOS and Control on Windows and Linux.

Configured shortcuts with the same id replace defaults. Set enabled: false to disable one. The supported actions are run-query and format-query; unknown actions are ignored.

Adding more shortcuts

The browser runtime exposes window.datasetteKeyboardShortcuts for other plugins. You can call it like this:

const unregister = window.datasetteKeyboardShortcuts.register({
  id: "focus-search",
  key: "Mod+K",
  handler: () => document.querySelector("input[type=search]")?.focus(),
});

Development

uv sync --extra test
uv run pytest