Skip to content

A minimal 🤏🏾 session management ⚡ plugin for your favorite editor ❤️.

License

Notifications You must be signed in to change notification settings

mistweaverco/kikao.nvim

Repository files navigation

Kikao Logo

Kikao.nvim

Lua GitHub release (latest by date)

RequirementsInstallConfigurationHow

A minimal session management plugin for your favorite editor.

Kikao is swahili for "session".

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

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 = { ".git", ".hg", ".bzr", ".svn" },
    -- The path to the session file
    -- If not provided, the session file will be stored in {{PROJECT_DIR}}/.nvim/session.vim
    session_file_path = nil,
  }
},

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.