just_nvim

Crates.iojust_nvim
lib.rsjust_nvim
version2.0.2
created_at2024-12-12 05:29:50.636723+00
updated_at2024-12-12 05:29:50.636723+00
descriptionNeovim plugin for encrypting and decrypting text files inside neovim using age with ease.
homepagehttps://github.com/abhi-xyz/just.nvim
repository
max_upload_size
id1480873
size1,031,287
Abhinandh S (abhinandh-s)

documentation

https://github.com/abhi-xyz/just.nvim

README

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
Commit count: 0

cargo fmt