just.nvim

Neovim plugin for encrypting and decrypting text files inside neovim using age with ease.

Installation

Install Just using your favorite plugin manager. For example, with lazy.nvim:

-- ~/.config/nvim/lua/plugins/just.lua

{
    'abhi-xyz/just.nvim',
    cmd = { "Just", "J" },
    config = function()
      local key = require('key')

      require('just').setup({
        public_key = "ageXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        private_key = key.private_key, -- defined in another lua file which is not included in git for safety
      })
    end
}

-- ~/.config/nvim/lua/key.lua

return {
  private_key = "AGE-SECRET-KEY-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
}

Usage

Just provides the :Just command with the following syntax:

:Just [action]

• [action] can be one of:
  • encrypt,
  • decrypt,

Examples:

• Kills the current buffer and switches to a previous buffer or creates a scratch buffer in case there is no buffer to switch, then encrypts the file with the provided age key.

:Just encrypt

• Decrypts the currently opened encrypted file, and switches to the decrypted file.

:Just decrypt