Chive

A Bash script for swapping out arbitrary file sections.

Table of Contents

• Getting Started
• Installation
  • Manual
  • Packages
• With Great Power...
• Usage
  • Targets
  • Variants
  • Switching
  • Deletion
• License

Getting Started

Chive allows you to easily replace arbitrary file sections with other text or data, without requiring modifications to the original file. To demonstrate this, let's walk through the process of setting up and switching between different color schemes for both Vim and Alacritty.

Configuration

First, we'll configure Chive. In particular, we'll need to:

1. Create targets for Vim and Alacritty so that Chive knows what files to operate on.
2. Create variants for each color scheme so that Chive knows what to switch between.

$ chive -t vim alacritty << EOF
> $HOME/.vimrc
> $HOME/.config/alacritty/alacritty.yml
> EOF
vim
alacritty

$ chive -v vim gruvbox <<< "colorscheme gruvbox"
$ chive -v vim solarized <<< "colorscheme solarized"
$ chive -v vim zenburn <<< "colorscheme zenburn"
vim: added "gruvbox"
vim: added "solarized"
vim: added "zenburn"

$ curl https://raw.githubusercontent.com/.../gruvbox.yml | chive -v alacritty gruvbox
alacritty: added "gruvbox"

$ chive -e -v alacritty solarized zenburn
  alacritty/solarized
> alacritty/zenburn
  2/2
>

As you can see, configuration is done primarily through STDIN. Where using STDIN doesn't make sense (e.g., when adding multiple variants), the --edit, -e flag will bring up an fzf listing of the relevant entries so that you may configure each one manually.

Switching

And that's it! You can now switch between your newly created color scheme variants for Vim, Alacritty, or both!

# vim & alacritty = solarized
$ chive solarized

# vim = gruvbox
$ chive vim gruvbox

# vim = solarized | alacritty = gruvbox
$ chive vim solarized alacritty gruvbox

# vim = zenburn | others = solarized
$ chive vim zenburn solarized

Installation

Manual

To build and install from source (requires fzf):

git clone https://github.com/bl0nd/chive.git
cd chive
sudo make install

With Great Power...

To avoid requiring modifications to the original file, Chive does require some help from you. In particular, variant switches require that the targeted file contains the contents of at least one variant belonging to the target.

For example, suppose you have the following setup (solarized contains colorscheme solarized):

$ grep colorscheme ~/.vimrc
colorscheme gruvbox

$ chive
vim
└── solarized

Running chive solarized will fail because there's no way for Chive to know where to begin replacing text. To fix this, either change gruvbox to solarized in ~/.vimrc or create a Gruvbox variant before running the command. Either way, Chive will then have a reference point to start from and the switch will be successful.

Usage

Targets

To create empty targets:

$ chive -t vim alacritty
alacritty
vim

To create full targets or modify existing ones:

$ chive -t vim alacritty << EOF
> $HOME/.vimrc
> $HOME/.config/alacritty/alacritty.yml
> EOF
alacritty
vim

$ chive -t bash-prompt bash-alias <<< ~/.bashrc
alacritty
bash-alias
bash-prompt
vim

Variants

To create empty variants for all targets:

$ chive -v solarized gruvbox
vim: added "solarized"
vim: added "gruvbox"
alacritty: added "solarized"
alacritty: added "gruvbox"

To create empty variants for some targets (order does not matter):

$ chive -v vim solarized gruvbox
vim: added "zenburn"
vim: added "ayu"

To create individual full variants:

$ chive -v vim solarized <<< "colorscheme solarized"
vim: added "solarized"

$ curl https://raw.githubusercontent.com/.../gruvbox_dark.yaml | chive -v alacritty gruvbox
alacritty: added "gruvbox"

To create multiple full variants, -e will bring up an fzf listing so that you may choose which to edit:

$ chive -e -v solarized gruvbox
  alacritty/gruvbox
  alacritty/solarized
  vim/gruvbox
> vim/solarized
  4/4
>

Switching

To switch variants for all targets:

$ chive solarized

To switch variants for some targets:

$ chive vim solarized alacritty gruvbox

To switch variants for some targets and all other targets:

$ chive vim solarized gruvbox

Deletion

To delete targets or variants, -d will bring up an fzf listing so that you may choose which to delete:

$ chive -d
  alacritty
  alacritty/gruvbox
  alacritty/solarized
  vim
  vim/gruvbox
> vim/solarized
  6/6
>

License

This project is released under the MIT license.