Obsidian Stats logoObsidian Stats

Key Sequence

by wantchane
5
4
3
2
1
Score: 50/100
Install Code

Description

Assign multi-key sequences to Obsidian command

Reviews

No reviews yet.

Stats

0
stars
78
downloads
0
forks
68
days
68
days
68
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
30
commits

Latest Version

2.0.0
2 months ago

Changelog

BREAKING CHANGES

  • Modal UI removed. Key sequences are no longer configured through Settings → Key Sequence → New keymap. Everything is now defined in a vimrc-style config file.
  • Vim mode integration removed. The plugin no longer cares about Obsidian's Vim mode. Instead, key sequences are simply disabled when an input/textarea/select/contentEditable element is focused.

Migration from 1.x

  1. Create a config file at .obsidian/key-sequence.vimrc (auto-created on first load).
  2. Rewrite your key sequences using the new syntax:
" comment
let mapleader = "<key>"
gmap <key-sequence> :<command-id><CR>
  1. Use Key Sequence: Reload config file to apply changes without restarting.
See all version on GitHub

README file from

Github

Key Sequence

Assign multi-key sequences to any Obsidian command, configured via a vimrc-style file.

How it works

Instead of a single chord, you press a sequence of keys to trigger a command. For example, press Space then h to toggle left sidebar.

No key sequences are pre-configured. You define your own in the config file.

Configuration

Key sequences are defined in a config file using vimrc-style syntax.

By default, the plugin looks for .obsidian/key-sequence.vimrc in your vault. You can change this path in the plugin settings.

Syntax

" comment
let mapleader = "<key>"
gmap <key-sequence> :<command-id><CR>
  • Lines starting with " are comments.
  • let mapleader defines a leader key referenced by <leader> in sequences. Note: This plugin has no Vim-style leader key. <leader> is simply a placeholder that gets substituted with the mapleader value. For example, let mapleader = "<Space>" means <leader>h behaves identically to writing <Space>h.
  • gmap maps a key sequence to an Obsidian command ID.

Examples

let mapleader = "<Space>"

gmap <leader>e :editor:focus<CR>

Settings

Open Settings → Key Sequence to configure:

  • Config file path — Relative path from vault root. Defaults to .obsidian/key-sequence.vimrc. The file is auto-created with a template on first load if it doesn't exist.

  • Embedded mode — Merge key sequences into another plugin's config file (e.g. Obsidian-Vimrc-Support's .obsidian.vimrc). When enabled, only lines prefixed with the marker below are parsed.

  • Line prefix marker — Only visible when embedded mode is on. Defines the prefix that marks a line as a key sequence definition (default: " ks>).

Embedded mode example

In your .obsidian.vimrc:

let mapleader = "<Space>"
" ks> let mapleader = "<Space>"

exmap file_explorer_reveal_active_file obcommand file-explorer:reveal-active-file
nmap <leader>e :file_explorer_reveal_active_file<CR>

" ks> gmap <leader>e :editor:focus<CR>

Usage

  1. Create your config file (or let the plugin auto-create it).
  2. Define your key sequences using the syntax above.
  3. Use the Key Sequence: Reload config file command to apply changes without restarting Obsidian.

Key sequences are disabled when an input, textarea, select, or contentEditable element is focused, so they won't interfere with typing.

Installation

Manual

Copy main.js, manifest.json to <vault>/.obsidian/plugins/key-sequence-obsidian/.

Notes

This plugin captures keydown events at the document level to match key sequences. Conflicts with other hotkeys are possible — if a sequence prefix matches another binding, the key sequence takes priority while a partial match is in progress.

Debug logging is written to the console with the Key Sequence: prefix.

Sponsors