Skip to content
This repository has been archived by the owner on Jan 1, 2024. It is now read-only.

Latest commit

 

History

History
55 lines (36 loc) · 1.63 KB

integration.md

File metadata and controls

55 lines (36 loc) · 1.63 KB

Integration with other tools

connect.kak is also a framework for developing your own plugins.

Default modules

Plugins that use or can work with connect.kak

Interacting with Kakoune

Integration with other applications usually comes from writing a small program, typically a shell script, and prefixed with : (e.g. :dolphin) by convention. Plugins can register their paths to the connect_paths option to add their utilities, and the same programs can be called inside Kakoune using the > or $ commands (e.g. > :yank-ring). Usually, plugin authors also provide a Kakoune command for them (e.g. yank-ring).

The basic commands for plugin crafting are:

  • :send: Send commands to the client.
  • :attach: Reattach to the session.
  • :get: Get a value from a client. Example: :get -quoting shell %val{selections}.
  • :edit: Open files.
  • :buffer: Open buffer.
  • :fifo: Send to fifo buffer the output of the given command, or read from stdin if available. Example: :fifo make.
  • :it: Get the current buffer path.
  • :ls: List buffers.