To register a new account on this wiki, contact us

Setting up vim-gpg plugin: Difference between revisions

From FSCI Wiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
use gitg to clone the vim gpg plugin
move easy option to top of the page and move command line setup to bottom
Line 1: Line 1:
vim-gpg plugin allows transparent editing for files encrypted using GPG .Those who are new to GPG can follow this [https://www.madboa.com/geek/gpg-quickstart/ guide].
vim-gpg plugin allows transparent editing for files encrypted using GPG .Those who are new to GPG can follow this [https://www.madboa.com/geek/gpg-quickstart/ guide].


1) Search "Gvim" in Software app (if you are using GNOME) and install. This is the easiest option.
== Graphical setup (Easy/GNOME) ==
1. Install Gvim: Search "Gvim" in Software app (if you are using GNOME) and install.  


OR
2. Install vim-gpg plugin:


Install vim using your package manager (Those who prefer the GUI way of doing things can use vim-gtk3).  
:2.1 Install gitg from GNOME Software
  sudo apt install vim
:2.2 Start gitg from activities.
OR
:2.3 Click on "Clone" option in gitg.
:2.4 Add https://github.com/jamessan/vim-gnupg.git as URL
:2.5 Select ~/.vim/pack/bundle/start/vim-gnupg as "Local Folder". In "Local Folder" drop down, choose "Other" at the bottom, click on "Home" on the left bar, choose Create Folder icon on top right, and enter .vim and then repeat the same to create each sub folders - pack, bundle, start, vim-gnupg. Then click Clone on the top right.
 
Now you can just right click on any encrypted file in your file manager and open with GVim. This plugin will decrypt the file and let you view or edit its contents. You can enable "Always use for this file type" to just open it by double clicking it next time.
 
== Advanced/Command line setup ==
 
1. Install vim using your package manager
  sudo apt install vim
 
OR (Those who prefer the GUI way of doing things can use vim-gtk3).
   sudo apt install vim-gtk3
   sudo apt install vim-gtk3


2) Install vim-gpg plugin .There are 3 ways you can do this:-
2. Install vim-gpg plugin


2a) Install gitg from GNOME Software and start gitg from activities. Click on "Clone" option in gitg.  Add https://github.com/jamessan/vim-gnupg.git as URL and select ~/.vim/pack/bundle/start/vim-gnupg as "Local Folder". In "Local Folder" drop down, choose "Other" at the bottom, click on "Home" on the left bar, choose Create Folder icon on top right, and enter .vim and then each sub folders. The click Clone on the top right.
:2a If you are on a debian based distro. There is a package called `vim-scripts` that already has this plugin. So installing this package would make things a lot easier
:2b) If you are on a debian based distro. There is a package called `vim-scripts` that already has this plugin. So installing this package would make things a lot easier
   sudo apt install vim-scripts
   sudo apt install vim-scripts


Line 21: Line 32:
::That's it ! Now you can open your gpg encrypted file using vim and it will ask for your passphrase.
::That's it ! Now you can open your gpg encrypted file using vim and it will ask for your passphrase.
:OR
:OR
:2c) You can use Vim's [https://vimhelp.org/repeat.txt.html#packages package] support to contain the plugin in its own directory.
:2b You can use Vim's [https://vimhelp.org/repeat.txt.html#packages package] support to contain the plugin in its own directory.
   mkdir -p ~/.vim/pack/bundle/start
   mkdir -p ~/.vim/pack/bundle/start
   cd ~/.vim/pack/bundle/start
   cd ~/.vim/pack/bundle/start

Revision as of 00:08, 28 September 2025

vim-gpg plugin allows transparent editing for files encrypted using GPG .Those who are new to GPG can follow this guide.

Graphical setup (Easy/GNOME)

1. Install Gvim: Search "Gvim" in Software app (if you are using GNOME) and install.

2. Install vim-gpg plugin:

2.1 Install gitg from GNOME Software
2.2 Start gitg from activities.
2.3 Click on "Clone" option in gitg.
2.4 Add https://github.com/jamessan/vim-gnupg.git as URL
2.5 Select ~/.vim/pack/bundle/start/vim-gnupg as "Local Folder". In "Local Folder" drop down, choose "Other" at the bottom, click on "Home" on the left bar, choose Create Folder icon on top right, and enter .vim and then repeat the same to create each sub folders - pack, bundle, start, vim-gnupg. Then click Clone on the top right.

Now you can just right click on any encrypted file in your file manager and open with GVim. This plugin will decrypt the file and let you view or edit its contents. You can enable "Always use for this file type" to just open it by double clicking it next time.

Advanced/Command line setup

1. Install vim using your package manager 

  sudo apt install vim

OR (Those who prefer the GUI way of doing things can use vim-gtk3). 

  sudo apt install vim-gtk3

2. Install vim-gpg plugin

2a If you are on a debian based distro. There is a package called `vim-scripts` that already has this plugin. So installing this package would make things a lot easier
  sudo apt install vim-scripts
Now add the line "packadd! gnupg" to your ~/.vimrc. You can use a graphical text editor like GNOME Text Editor or GVim to open ~/.vimrc file and add this line to the end of the file (if it has some contents already or just add it to the start if the file is empty).
  echo "packadd! gnupg" >> ~/.vimrc
That's it ! Now you can open your gpg encrypted file using vim and it will ask for your passphrase.
OR
2b You can use Vim's package support to contain the plugin in its own directory.
  mkdir -p ~/.vim/pack/bundle/start
  cd ~/.vim/pack/bundle/start
  git clone git@github.com:jamessan/vim-gnupg.git
Vim will find and load everything on its own, without mixing the files with others.
Retrieved from "https://wiki.fsci.in/index.php?title=Setting_up_vim-gpg_plugin&oldid=11113"