souvenir.nvim

A Neovim plugin that manages Neovim sessions

Requirement

Neovim 0.7+

Installation

vim-plug

Plug 'ingram1107/souvenir.nvim'

packer

use {
  'ingram1107/souvenir.nvim',
}

Usage

You could set-up your session path as follows:

require('souvenir').setup {
  session_path = '~/.config/nvim/sessions'
}

Or else the default session path would be set to a directory named souvenirs in your system's standard data path. ($XDG_DATA_HOME/nvim if you are using Linux, ~/AppData/Local/nvim-data if you are using Windows)

Other settings such as override and shada are available too. Set override to true will allow the behaviour of overriding an existing session to be the default behaviour. Set shada to true will allow more information in the current session to be stored such as command line history, contents of registers and marks for files. (more details see :h shada) Defaults values are set as below:

require('souvenir').setup {
  override = false,
  shada = true,
}

souvenir.nvim currently provides 6 functionalities: save Vim session, restore Vim session, delete Vim session, continuous session recording, stop such recording, and list Vim sessions. Commands to call these 6 functionalities are shown as below:

:SouvenirSave[!]    " save session (`!` to override)
:SouvenirRestore
:SouvenirDelete     " accept multiple files
:SouvenirRecord     " record current session
:SouvenirStopRecord
:SouvenirList

:lua require('souvenir').save_session{'souvenir'} -- don't override existing session file
:lua require('souvenir').save_session{'souvenir', true} -- override exisitng session file
:lua require('souvenir').restore_session('souvenir')
:lua require('souvenir').delete_session({ 'souvenir', 'memoir', 'nostalgic' })
:lua require('souvenir'),record_session('souvenir') -- automatic override
:lua require('souvenir').stop_record_session()
:lua require('souvenir').list_session()

If option override is set to true, there should be no behavioural differences between :SouvenirSave and :SouvenirSave! or their lua counterparts. Note that SouvenirRecord will override regardless of the override option value.

Inspiration

xolox/vim-session tpope/vim-obsession

Todo

• documentation
• save session to a pre-configured location
• restore session
• delete session
  • delete multiple sessions
• list sessions
• session name completion
• interactive buffer (telescope)
• cross-platform
  • Windows
  • Linux
  • macOS (waiting for someone to test)
  • BSD-variants (waiting for someone to test)