psittacus / swim

πŸŠβ€β™€οΈ Switch between multiple vimrc files

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

swim logo

switch vimrc files instantly


Demo

demo fig


Why

Trying out and switching vimrc's shouldn't be hard. It shouldn't require several mv's combined with a wget. Most importantly, it shouldn't stop you from always having the perfect vim configuration so you can be efficient.

swim add vimrc's directly from the internet

or locally and alias your vimrc's with names that are easy to remember. Swim entirely replaces the need for per-directory vimrc's, headers, and external vimrc configs.

Install

Backup your files before swimming

curl -s https://raw.githubusercontent.com/dawsonbotsford/swim/master/install | bash

Examples

  swim add ~/dotfiles/myVimrc favorite    #Add new swim alias
  swim ls                                 #Show available swim aliases
  swim add https://raw.githubusercontent.com/dawsonbotsford/swim/master/exampleVimrcs/vimrcWikia.vim example
  swim with favorite         #Set alias favorite as primary .vimrc
  swim with main             #Set alias main as primary .vimrc

Update

swim update       #Update to the newest version of swim

Available Commands

swim add <URLToRaw or pathToFile>  <alias>   #Add a swim alias
swim with <alias>                            #Change active vimrc file
swim ls                                      #List aliased vimrc files
swim active                                  #Show currently aliased vimrc
swim vim <alias>                             #Edit the vimrc stored at alias

swim mv <alias1> <alias2>                    #Rename alias (like Linux mv)
swim rm <alias>                              #Delete an alias entirely
swim update                                  #Download newest version
swim version                                 #Print version
swim help                                    #Print this message

FAQ

  • Where does swim store my vimrc files?
    • swim stores your vimrc files in ~/.swim. You can edit the vimrc files with swim vim <alias> or edit them manually from their file location.

  • Can I set a custom executable location?
  • Yes, the default install location of the swim executable is /usr/local/bin, but if you would like a custom location, simply set the environmental variable named usrDir.
  • Example: export usrDir="/usr/sbin" (That only needs to be set for when you perform the swim install. So no need to set this in your bashrc or zshrc)

  • Does swim support emacs?
    • No, but pull requests are always welcome :)

  • Can I call swim within vim?
    • It may be possible to hack together a several command :! solution at the moment, but there is not a supported method.

Requirements

  • node.js and npm (to auto-install chalk-cli)

Changelog

  • 0.4.0-prelaunch: Custom executable install location
  • 0.3.2-prelaunch: Prelaunch Beta Testing

About

πŸŠβ€β™€οΈ Switch between multiple vimrc files

License:MIT License


Languages

Language:Shell 58.8%Language:Vim Script 41.2%