Kikao.nvim

What • Requirements • Install • Configuration • How

A minimal session management plugin for your favorite editor.

Kikao is swahili for "session".

What

It's a simple plugin that allows you to automatically save and restore your session when you open and close neovim.

It basically saves the state of your editor when you close it and restores it when you open it.

So you have your window layout and buffers just as you left them.

Requirements

• Neovim 0.10.0+

Install

Via lazy.nvim:

{ 'mistweaverco/kikao.nvim', opts = {} },

Note

opts needs to be at least an empty table {} and can't be completely omitted.

Configuration

{ 'mistweaverco/kikao.nvim',
  opts = {
    -- Checks for the existence of the project root by checking for these directories
    project_dir_matchers = { ".editor" },
    -- The path to the session file
    -- If not provided, the session file will be stored in {{PROJECT_DIR}}/.editor/neovim-session.vim
    session_file_path = nil,
    -- Don't start or restore a session if the file is in the deny_on_path list
    -- and you opened that file directly
    deny_on_path = {
      ".git/COMMIT_EDITMSG",
    },
  }
},

Create a .editor directory in your project root and add the following to your .gitignore file:

.editor/neovim-session.vim

How

How does it work?

• When you open neovim, kikao will check if there is a session file in the project root.
• If there is a session file, it will be loaded.
• When you close neovim, kikao will save the session file in the project root.