image:https://rawgit.com/mawww/kakoune/master/doc/kakoune_logo.svg[K,30,30] Kakoune image:https://travis-ci.org/mawww/kakoune.svg[link="https://travis-ci.org/mawww/kakoune"] ============================================================================================================================================================================= TL;DR ----- *Vim inspired* -- *Faster as in less keystrokes* -- *Multiple selections* -- *Orthogonal design* --------------------------------------------- git clone http://github.com/mawww/kakoune.git cd kakoune/src make make userconfig ./kak --------------------------------------------- See http://github.com/mawww/golf for kakoune solutions to vimgolf challenges, regularly beating the best vim solution. Introduction: ------------- Kakoune is a code editor heavily inspired by Vim, as such most of it's commands are similar to vi's ones. Kakoune can operate in two modes, normal and insertion. In insertion mode, keys are directly inserted into the current buffer. In normal mode, keys are used to manipulate the current selection and to enter insertion mode. Kakoune has a strong focus on interactivity, most commands provide immediate and incremental results, while still being competitive (as in keystroke count) with Vim. Kakoune works on selections, which are oriented, inclusive range of characters, selections have an anchor and a cursor character. Most commands move both of them, except when extending selection where the anchor character stays fixed and the cursor one moves around. see http://vimeo.com/82711574 Join us on freenode IRC +#Kakoune+ Features -------- * Multiple selections as a central way of interacting * Powerful selection manipulation primitives - Select all regex matches in current selections - Keep selections containing/not containing a match for a given regex - Split current selections with a regex - Text objects (paragraph, sentence, nestable blocks) * Powerful text manipulation primitives - Align selections - Rotate selection contents - Case manipulation - Indentation - Piping each selection to external filter * Client-Server architecture - Multiple clients on the same editing session - Use tmux or your X11 window manager to manage windows * Simple interaction with external programs * Automatic contextual help * Automatic as you type completion * Macros * Hooks * Syntax Highlighting - Supports multiple languages in the same buffer - Highlight a buffer differently in different windows Building -------- Kakoune dependencies are: * A C++11 compliant compiler (GCC >= 4.8.1 or clang >= 3.4) * boost (>= 1.50) * ncurses with wide-characters support (>= 5.3, generally refered as libncursesw) To build, just type *make* in the src directory Kakoune can be built on Linux, MacOS, and Cygwin. Due to Kakoune relying heavily on being in an Unix like environment, no native Windows version is planned. To setup a basic configuration on your account, type *make userconfig* in the src directory, this will setup an initial $XDG_CONFIG_HOME/kak directory. See the _Kakrc_ section for more information. Installing ---------- In order to install kak on your system, rather than running it directly from it's source directory, type *make install*, you can specify the +PREFIX+ and +DESTDIR+ if needed. Note that by default, no script files will be read if you do not add links to them in $XDG_CONFIG_HOME/kak/autoload. Available script files will be installed in $PREFIX/share/kak/rc If you want to enable all files, set $XDG_CONFIG_HOME/kak/autoload to be a symbolic link to the $PREFIX/share/kak/rc directory. ---------------------------------------------- ln -s /usr/share/kak/rc ~/.config/kak/autoload ---------------------------------------------- Homebrew (OSX) ~~~~~~~~~~~~~~ ----------------------------------------------------------------------------------------------- brew install --HEAD https://raw.githubusercontent.com/mawww/kakoune/homebrew/contrib/kakoune.rb ----------------------------------------------------------------------------------------------- Fedora 21/22/Rawhide ~~~~~~~~~~~~~~~~~~~~ Use created copr repository https://copr.fedoraproject.org/coprs/jkonecny/kakoune/ --------------------------------- dnf copr enable jkonecny/kakoune dnf install kakoune --------------------------------- Running ------- Just running *kak* launch a new kak session with a client on local terminal. *kak* accepts some switches: * +-c +: connect to given session, sessions are unix sockets +/tmp/kak-+ * +-e +: execute commands on startup * +-n+: ignore kakrc file * +-s +: set the session name, by default it will be the pid of the initial kak process. * +-d+: run Kakoune in daemon mode, without user interface. This requires the session name to be specified with -s. In this mode, the Kakoune server will keep running even if there is no connected client, and will quit when receiving SIGTERM. * +-p +: read stdin, and then send its content to the given session acting as a remote control. * +-f +: Work as a filter, read every file given on the command line and stdin if piped in, and apply given keys on each. At startup, if +-n+ is not specified, Kakoune will try to source the file ../share/kak/kakrc relative to the kak binary. This kak file will then try to source any files in $XDG_CONFIG_HOME/kak/autoload (with $XDG_CONFIG_HOME defaulting to $HOME/.config), and finally $XDG_CONFIG_HOME/kak/kakrc. The common pattern is to add links to $XDG_CONFIG_HOME/kak/autoload to the scripts in $PREFIX/share/kak/rc that the user wants sourced at kak launch. Basic Movement -------------- * _h_: select the character on the right of selection end * _j_: select the character below the selection end * _k_: select the character above the selection end * _l_: select the character on the left of selection end * _w_: select the word and following whitespaces on the right of selection end * _b_: select preceding whitespaces and the word on the left of selection end * _e_: select preceding whitespaces and the word on the right of selection end * _alt-[wbe]_: same as [wbe] but select WORD instead of word * _x_: select line on which selection end lies (or next line when end lies on an end-of-line) * _alt-x_: expand selections to contain full lines (including end-of-lines) * _alt-X_: trim selections to only contain full lines (not including last end-of-line) * _%_: select whole buffer * _alt-H_: select to line begin * _alt-L_: select to line end * _/_: search (select next match) * _?_: search (extend to next match) * _n_: select next match * _N_: add a new selection with next match * _alt-n_: select previous match * _alt-N_: add a new selection with previous match * _pageup_: scroll up * _pagedown_: scroll down * _alt-r_: rotate selections (the main selection becomes the next one) * _;_: reduce selections to their cursor * _alt-;_: flip the selections direction A word is a sequence of alphanumeric characters or underscore, a WORD is a sequence of non whitespace characters. Appending --------- for most selection commands, using shift permits to extend current selection instead of replacing it. for example, _wWW_ selects 3 consecutive words Using Counts ------------ Most selection commands also support counts, which are entered before the command itself. for example, _3W_ selects 3 consecutive words and _3w_ select the third word on the right of selection end. Changes ------- * _i_: insert before current selection * _a_: insert after current selection * _d_: yank and delete current selection * _c_: yank and delete current selection and insert * _._: repeat last insert mode change (_i_, _a_, or _c_, including the inserted text) * _I_: insert at current selection begin line start * _A_: insert at current selection end line end * _o_: insert in a new line below current selection end * _O_: insert in a new line above current selection begin * _y_: yank selections * _p_: paste after current selection end * _P_: paste before current selection begin * _alt-p_: paste all after current selection end, and select each pasted string. * _alt-P_: paste all before current selection begin, and select each pasted string. * _R_: replace current selection with yanked text * _r_: replace each character with the next entered one * _alt-j_: join selected lines * _alt-J_: join selected lines and select spaces inserted in place of line breaks * _>_: indent selected lines * _<_: deindent selected lines * _alt->_: indent selected lines, including empty lines * _<_: deindent selected lines * _alt-<_: deindent selected lines, do not remove incomplete indent (3 leading spaces when indent is 4) * _|_: pipe each selections through the given external filter program and replace the selection with it's output. * _alt-|_: pipe each selections through the given external filter program and ignore its output * _!_: insert command output before selection * _a-!_: append command output after selection * _u_: undo last change * _U_: redo last change * _&_: align selection, align the cursor of selections by inserting spaces before the first character of the selection * _alt-&_: copy indent, copy the indentation of the main selection (or the count one if a count is given) to all other ones * _`_: to lower case * _~_: to upper case * _alt-`_: swap case * _@_: convert tabs to spaces in current selections, uses the buffer tabstop option or the count parameter for tabstop. * _alt-@_: convert spaces to tabs in current selections, uses the buffer tabstop option or the count parameter for tabstop. * _alt-R_: rotate selections content, if specified, the count groups selections, so +3+ rotate (1, 2, 3) and (3, 4, 6) independently. Goto Commands ------------- Commands begining with g are used to goto certain position and or buffer: * _gh_: select to line begin * _gl_: select to line end * _gg_, _gk_: go to the first line * _gj_: go to the last line * _gt_: go to the first displayed line * _gc_: go to the middle displayed line * _gb_: go to the last displayed line * _ga_: go to the previous (alternate) buffer * _gf_: open the file whose name is selected * _g._: go to last buffer modifiction position View commands ------------- Some commands, all begining with v permit to manipulate the current view. * _vv_ or _vc_: center the main selection in the window * _vt_: scroll to put the main selection on the top line of the window * _vb_: scroll to put the main selection on the bottom line of the window * _vh_: scroll the window count columns left * _vj_: scroll the window count line downward * _vk_: scroll the window count line upward * _vl_: scroll the window count columns right Jump list --------- Some commands, like the goto commands, buffer switch or search commands, push the previous selections to the client's jump list. It is possible to forward or backward in the jump list using: * _control-i_: Jump forward * _control-o_: Jump backward * _control-s_: save current selections Multi Selection --------------- Kak was designed from the start to handle multiple selections. One way to get a multiselection is via the _s_ key. For example, to change all occurences of word 'roger' to word 'marcel' in a paragraph, here is what can be done: select the paragraph with enough _x_. press _s_ and enter roger then enter. now paragraph selection was replaced with multiselection of each roger in the paragraph. press _c_ and marcel to replace rogers with marcels. A multiselection can also be obtained with _S_, which splits the current selection according to the regex entered. To split a comma separated list, use _S_ then ', *' _s_ and _S_ share the search pattern with _/_, and hence entering an empty pattern uses the last one. As a convenience, _alt-s_ allows you to split the current selections on line boundaries. To clear multiple selections, use _space_. To keep only the nth selection use _n_ followed by _space_, in order to remove a selection, use _alt-space_. _alt-k_ allows you to enter a regex and keep only the selections that contains a match for this regex. using _alt-K_ you can keep the selections not containing a match. _C_ copies the current selection to the next line (or lines if a count is given) _alt-C_ does the same to previous lines. _$_ allows you to enter a shell command and pipe each selections to it. Selections whose shell command returns 0 will be kept, other will be dropped. Object Selection ---------------- Some keys allow you to select a text object: * _alt-a_: selects the whole object * _alt-i_: selects the inner object, that is the object excluding it's surrounder. for example, for a quoted string, this will not select the quote, and for a word this will not select trailing spaces. * _[_: selects to object start * _]_: selects to object end * _{_: extends selections to object start * _}_: extends selections to object end After this key, you need to enter a second key in order to specify which object you want. * _b_, _(_ or _)_: select the enclosing parenthesis * _B_, _{_ or _}_: select the enclosing {} block * _r_, _[_ or _]_: select the enclosing [] block * _a_, _<_ or _>_: select the enclosing <> block * _"_: select the enclosing double quoted string * _'_: select the enclosing single quoted string * _`_: select the enclosing grave quoted string * _w_: select the whole word * _W_: select the whole WORD * _s_: select the sentence * _p_: select the paragraph * _␣_: select the whitespaces * _i_: select the current indentation block * _n_: select the number For nestable objects, a count can be used in order to specify which surrounding level to select. Registers --------- registers are named list of text. They are used for various purpose, like storing the last yanked test, or the captures groups associated with the selections. While in insert mode, ctrl-r followed by a register name (one character) inserts it. For example, ctrl-r followed by " will insert the currently yanked text. ctrl-r followed by 2 will insert the second capture group from the last regex selection. Registers are lists, instead of simply text in order to interact well with multiselection. Each selection have it's own captures, or yank buffer. Macros ------ Kakoune can record and replay a sequence of key press. When pressing the _Q_ key, followed by an alphabetic key for the macro name, Kakoune begins macro recording: every pressed keys will be added to the macro until the _Q_ key is pressed again. To replay a macro, use the _q_ key, followed by the macro name. Search selection ---------------- Using the _*_ key, you can set the search pattern to the current selection. This tries to be intelligent. It will for example detect if current selection begins and/or end at word boundaries, and set the search pattern accordingly. with _alt-*_ you can set the search pattern to the current seletion without Kakoune trying to be smart. Basic Commands -------------- Commands are entered using +:+. * +e[dit] [ []]+: open buffer on file, go to given line and column. If file is already opened, just switch to this file. use edit! to force reloading. * +w[rite] []+: write buffer to or use it's name if filename is not given. * +w[rite]a[ll]+: write all buffers that are associated to a file. * +q[uit]+: exit Kakoune, use quit! to force quitting even if there is some unsaved buffers remaining. * +wq+: write current buffer and quit * +b[uffer] +: switch to buffer * +d[el]b[uf] []+: delete the buffer , use d[el]b[uf]! to force deleting a modified buffer. * +source +: execute commands in * +runtime +: execute commands in , is relative to kak executable path. * +nameclient +: set current client name * +namebuf +: set current buffer name * +echo +: show in status line * +nop+: does nothing, but as with every other commands, arguments may be evaluated. So nop can be used for example to execute a shell command while being sure that it's output will not be interpreted by kak. +:%sh{ echo echo tchou }+ will echo tchou in Kakoune, whereas +:nop %sh{ echo echo tchou }+ will not, but both will execute the shell command. Exec and Eval ------------- the +:exec+ and +:eval+ commands can be used for running Kakoune commands. +:exec+ keys as if they were pressed, whereas +:eval+ executes it's given paremeters as if they were entered in the command prompt. By default, they do their execution in the context of the current client. Some parameters provide a way to change the context of execution: * +-client +: execute in the context of the client named * +-try-client +: execute in the context of the client named if such client exists, or else in the current context. * +-draft+: execute in a copy of the context of the selected client modifications to the selections or input state will not affect the client. This permits to make some modification to the buffer without modifying the user's selection. * +-itersel+ (requires +-draft+): execute once per selection, in a context with only the considered selection. This permits to avoid cases where the selections may get merged. * +-buffer +: execute in the context of each buffers in the comma separated list * +-no-hooks+: disable hook execution while executing the keys/commands The execution stops when the last key/command is reached, or an error is raised. key parameters gets concatenated, so the following commands are equivalent. ---------------------- :exec otest1 :exec o test 1 ---------------------- String syntax ------------- When entering a command, parameters are separated by whitespace (shell like), if you want to give parameters with spaces, you should quote them. Kakoune support three string syntax: * +\'strings\'+: uninterpreted strings, you can use \' to escape the separator, every other char is itself. * +"strings"+: expended strings, % strings (see %sh, %opt or %reg) contained are expended. Use \% to escape a % inside them, and \\ to escape a slash. * +%\{strings\}+: these strings are very useful when entering commands - the '{' and '}' delimiter are configurable: you can use any non alphanumeric character. like %[string], %, %(string), %~string~ or %!string!... - if the character following the % is one of {[(<, then the closing one is the matching }])> and the delimiters are not escapable but are nestable. for example +%{ roger {}; }+ is a valid string, +%{ marcel \}+ as well. Options ------- For user configuration, Kakoune supports options. Options are typed, their type can be * +int+: an integer number * +bool+: a boolean value, +yes/true+ or +no/false+ * +yesnoask+: similar to a boolean, but the additional value +ask+ is supported. * +str+: a string, some freeform text * +coord+: a line,column pair (separated by comma) * +regex+: as a string but the +set+ commands will complain if the entered text is not a valid regex. * +{int,str}-list+: a list, elements are separated by a colon (:) if an element needs to contain a colon, it can be escaped with a backslash. Options value can be changed using the +set+ commands: -------------------------------------------------------------- :set [global,buffer,window]