Sheldon works by specifying plugin information in a TOML
configuration file, plugins.toml
. You can initialize this file by running
sheldon init
.
sheldon init --shell bash
or
sheldon init --shell zsh
This will create plugins.toml
under $XDG_CONFIG_HOME/sheldon
, on most
systems this will be ~/.config/sheldon/plugins.toml
. You can either edit this
file directly or use the provided command line interface to add or remove
plugins.
To add your first plugin append the following to the Sheldon config file.
# ~/.config/sheldon/plugins.toml
[plugins.base16]
github = "chriskempson/base16-shell"
Or use the add
command to automatically add it.
sheldon add base16 --github chriskempson/base16-shell
The first argument given here base16
is a unique name for the plugin. The
--github
option specifies that we want Sheldon to manage a clone of the
https://github.com/chriskempson/base16-shell
repository.
You can then use sheldon source
to install this plugin, generate a lock file,
and print out the shell script to source. Simply add the following to your
~/.zshrc
or ~/.bashrc
file.
# ~/.zshrc or ~/.bashrc
eval "$(sheldon source)"