Skip to main content
Glide’s keymap system provides powerful, Vim-style keyboard shortcuts that are mode-aware and fully customizable. You can map key sequences to commands, functions, or even content scripts.

​
Basic Usage

Keymaps are set using glide.keymaps.set() with three required parameters: 
glide.keymaps.set(mode, key_sequence, action);

​
Simple Command Mapping

Map a key sequence to an ex-command: 
// Reload page with Space+r in normal mode
glide.keymaps.set("normal", "<leader>r", "reload");

// Scroll to top with 'gg'
glide.keymaps.set("normal", "gg", "scroll_top");

// Close tab with Space+d
glide.keymaps.set("normal", "<leader>d", "tab_close");

​
Multi-Mode Mappings

Apply the same mapping to multiple modes: 
// Ctrl+d scrolls down in both normal and insert modes
glide.keymaps.set(["insert", "normal"], "<C-d>", "scroll_half_page_down");

// Ctrl+j for next tab works in normal and insert
glide.keymaps.set(["normal", "insert"], "<C-j>", "tab_next");

​
Key Notation

Glide uses Vim-style key notation with angle brackets for special keys:
Modifiers are specified with angle bracket notation:
  • <C-x> - Control + x
  • <A-x> - Alt + x (Option on macOS)
  • <S-x> - Shift + x
  • <D-x> - Command key (macOS only)
  • <M-x> - Meta key
Multiple modifiers:
glide.keymaps.set("normal", "<C-S-n>", "tab_new");

​
Action Types

The right-hand side (action) of a keymap can be a command string, JavaScript function, or content script:

​
Command Strings

Execute ex-commands with optional arguments: 
// Simple command
glide.keymaps.set("normal", "<leader>r", "reload");

// Command with arguments
glide.keymaps.set("normal", "F", "hint --action=newtab-click");
glide.keymaps.set("normal", "<leader>f", "hint --location=browser-ui");
glide.keymaps.set("normal", "gi", "focusinput last");

// Mode change with options
glide.keymaps.set("normal", "i", "mode_change insert --automove=left");
glide.keymaps.set("normal", "A", "mode_change insert --automove=endline");

​
JavaScript Functions

Execute custom JavaScript code: 
// Simple function
glide.keymaps.set("normal", "<leader>n", () => {
  console.log("Custom action executed!");
});

// Access Glide APIs
glide.keymaps.set("normal", "<leader>u", () => {
  const url = glide.ctx.url.href;
  console.log("Current URL:", url);
});

// Async function
glide.keymaps.set("normal", "<leader>p", async () => {
  const result = await glide.process.execute("echo", ["Hello from Glide"]);
  console.log(result.stdout);
});

​
Content Functions

Execute code in the page context (content script): 
glide.keymaps.set("normal", "<leader>h", async ({ content }) => {
  // Runs in the web page context
  const title = await content.execute(() => {
    return document.title;
  });
  console.log("Page title:", title);
});

​
Keymap Options

Provide additional options as the fourth parameter:

​
Description

Add human-readable descriptions for documentation: 
glide.keymaps.set(
  "normal",
  "<A-p>",
  "tab_pin_toggle",
  { description: "Pin or unpin the current tab" }
);

glide.keymaps.set(
  "normal",
  "gI",
  () => glide.hints.show({ 
    auto_activate: true, 
    editable: true, 
    pick: hinting.pickers.biggest_area 
  }),
  { description: "Focus the largest editable element on the page" }
);

​
Retain Key Display

Keep showing the key sequence in the UI after execution: 
// Show 'd' in status while waiting for motion
glide.keymaps.set(
  "normal",
  "d",
  "mode_change op-pending --operator=d",
  { retain_key_display: true }
);

​
Platform-Specific Keymaps

Create different mappings based on the operating system: 
// From the default keymaps
if (glide.ctx.os === "macosx") {
  glide.keymaps.set(["normal", "insert"], "<C-h>", "back");
  glide.keymaps.set(["normal", "insert"], "<C-l>", "forward");
} else {
  // Linux/Windows - avoid <C-l> conflict
  glide.keymaps.set(["normal", "insert"], "<A-h>", "back");
  glide.keymaps.set(["normal", "insert"], "<A-l>", "forward");
}
Available platforms: "linux", "win", "macosx", "ios", "android", "other"

​
Removing Keymaps

Delete existing keymaps: 
// Remove a specific mapping
glide.keymaps.del("normal", "<leader>r");

// Remove from multiple modes
glide.keymaps.del(["normal", "insert"], "<C-j>");
Removing a keymap that doesn’t exist will throw an error. Use try-catch if you’re unsure:
try {
  glide.keymaps.del("normal", "<leader>x");
} catch (e) {
  console.log("Keymap didn't exist");
}

​
Listing Keymaps

Inspect currently defined keymaps: 
// List all keymaps
const all = glide.keymaps.list();

// List keymaps for specific mode
const normal_maps = glide.keymaps.list("normal");

// List for multiple modes
const maps = glide.keymaps.list(["normal", "insert"]);

// Inspect a keymap
console.log(normal_maps[0]);
// {
//   mode: "normal",
//   lhs: "gg",
//   rhs: "scroll_top",
//   description: undefined
// }

​
Default Keymaps Reference

Here are some commonly used default keymaps from plugins/keymaps.mts:

​
Mapping Timeout

Control how long Glide waits for the next key in a sequence: 
// Wait 500ms instead of default 200ms
glide.o.mapping_timeout = 500;
The mapping timeout only applies in insert mode. In normal mode, partial sequences wait indefinitely.

​
Advanced: Buffer-Scoped Keymaps

Create keymaps that only apply to the current buffer (tab): 
// Only active in the current tab
glide.buf.keymaps.set("normal", "<leader>t", () => {
  console.log("This only works in this tab!");
});

// Remove buffer keymap
glide.buf.keymaps.del("normal", "<leader>t");

​
Source Code References

  • Keymap API: src/glide/browser/base/content/browser-api.mts:303-313
  • Default keymaps: src/glide/browser/base/content/plugins/keymaps.mts
  • Key notation parser: src/glide/browser/base/content/utils/keys.mts
  • Keymap trie structure: src/glide/browser/base/content/utils/keys.mts:30-136

Build docs developers (and LLMs) love

Get started for freeTalk to us