summaryrefslogtreecommitdiff
path: root/README.md
blob: 921fdf97e0fe984c1cda4d54ff337bf28efa6332 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# kak-harpoon

Quickly save and switch between your most important Kakoune files.

Inspired by [Harpoon](https://github.com/ThePrimeagen/harpoon) for Neovim.

[![asciicast](https://asciinema.org/a/MH4yLhuW5y4ryWQRxz7VZxD4Q.svg)](https://asciinema.org/a/MH4yLhuW5y4ryWQRxz7VZxD4Q)

## Installation

Source `harpoon.kak` in your `kakrc`, or use a plugin manager.

## Usage

Call `harpoon-add-bindings` to add the default keybindings:

- `<user>h`: Harpoon the current file
- `<user>H`: View harpoons list
- `<a-1>`: Navigate to the harpoon at position 1
- `<a-2>`: Navigate to the harpoon at position 2
- ...and so on up through `<a-9>`.

The harpoons list is an interactive buffer listing all of your current
harpoons. You can freely edit or reorder this file, then call `write` to save
it. The new order / contents will be set as your new harpoons. Press `<esc>` to
close the harpoons list.

## Customization

If the default bindings do not work for you, here are the relevant commands to call:

- `harpoon-add`: Harpoon the current file
- `harpoon-nav <index>`: Navigate to the harpoon at `<index>`
- `harpoon-show-list`: View the harpoons list

## Roadmap

- Save line and column information
- Persist harpoons per-session