guide.md

Guide

Configuration

Kakoune example configuration:

~/.config/kak/kakrc

# Preamble
evaluate-commands %sh{
  kcr init kakoune
}

# Mappings
map -docstring 'new client' global normal <c-t> ': new<ret>'
map -docstring 'terminal (popup)' global normal <c-ret> ': connect terminal-popup<ret>'
map -docstring 'git (popup)' global normal <c-l> ': connect terminal-popup gitui<ret>'
map -docstring 'file explorer' global normal <c-e> ': connect terminal-panel sidetree --select %val{buffile}<ret>'
map -docstring 'file picker' global normal <c-f> ': connect terminal-popup kcr fzf files<ret>'
map -docstring 'buffer picker' global normal <c-b> ': connect terminal-popup kcr fzf buffers<ret>'
map -docstring 'grep picker' global normal <c-g> ': connect terminal-popup kcr fzf grep<ret>'
map -docstring 'grep picker (buffer)' global normal <c-r> ': connect terminal-popup kcr fzf grep %val{buflist}<ret>'

Bash example configuration:

~/.bashrc

alias k='kcr edit'
alias K='kcr-fzf-shell'
alias KK='K --working-directory .'
alias ks='kcr shell --session'
alias kl='kcr list'
alias a='kcr attach'

# Open files _from_ and _to_ a session.
# $ :f src
# $ f: mawww/kakoune
alias :f='kcr fzf files'
alias f:='KK kcr fzf files'
alias fm:='K sidetree --working-directory'

alias :g='kcr fzf grep'
alias g:='KK kcr fzf grep'

Environment variables example configuration:

~/.profile

export EDITOR='kcr edit'
export FZF_DEFAULT_OPTS='--multi --layout=reverse --preview-window=down:60%'

XDG MIME Applications example configuration:

~/.config/mimeapps.list

[Default Applications]
text/plain=kcr.desktop

You can get the MIME type with:

file -b -i -L <file>

Writing plugins

kcr play

See the play command and example.kak file.