https://github.com/mistweaverco/kikao.nvim

A minimal 🤏🏾 session management ⚡ plugin for your favorite editor ❤️.
https://github.com/mistweaverco/kikao.nvim

lua neovim neovim-plugin session session-management sessions

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/mistweaverco/kikao.nvim
• Owner: mistweaverco
• License: mit
• Created: 2024-09-11T21:18:34.000Z (22 days ago)
• Default Branch: main
• Last Pushed: 2024-09-12T08:40:00.000Z (21 days ago)
• Last Synced: 2024-09-23T03:04:24.034Z (10 days ago)
• Topics: lua, neovim, neovim-plugin, session, session-management, sessions
• Language: Lua
• Homepage:
• Size: 38.1 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


![Kikao Logo](logo.svg)

# Kikao.nvim

![Lua](https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua)

[![GitHub release (latest by date)](https://img.shields.io/github/v/release/mistweaverco/kikao.nvim?style=for-the-badge)](https://github.com/mistweaverco/kikao.nvim/releases/latest)

[Requirements](#requirements) • [Install](#install) • [Configuration](#configuration) • [How](#how)



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](https://github.com/folke/lazy.nvim):

```lua

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

```

> [!NOTE]

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

## Configuration

```lua

{ '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.