A fast, configurable, shell plugin manager
A fast, configurable, shell plugin manager
~/.zshrc or ~/.bashrc (just add 1 line).Pre-built binaries for Linux (x86-64, armv7) and macOS (x86-64) can be found on the releases page.
Alternatively, the following script can be used to automatically detect your host system, download the required artefact, and extract the sheldon binary.
sh
curl --proto '=https' -fLsS https://rossmacarthur.github.io/install/crate.sh \
| bash -s -- --repo "rossmacarthur/sheldon" --to /usr/local/bin
sheldon can be installed using [cargo], the Rust package manager. Install [cargo] using [rustup] then run the following command to install or update sheldon.
sh
cargo install sheldon
Please see all release notes here.
sheldon works by specifying all plugin information in a [TOML] configuration
file. Then sourcing the output of sheldon source in your ~/.zshrc or
~/.bashrc file. When this command is run sheldon will download all the
required plugin sources, generate a lock file, and then output shell source.
By default the config file is located at ~/.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 to the config file run the sheldon
add command.
sh
sheldon add oh-my-zsh --github robbyrussell/oh-my-zsh
The first argument given here oh-my-zsh is a unique name for the plugin. The
--github option specifies that we want sheldon to manage a clone of
http://github.com/robbyrussell/oh-my-zsh. If this is the first time you are
running sheldon, you will be asked if you want to initialize a new config
file at ~/.sheldon/plugins.toml.
You can then use sheldon source to install the configured plugins, generate
the lock file, and print out the shell script to source. Simply add the
following to your ~/.zshrc or ~/.bashrc file.
```sh
source <(sheldon source) ```
lock commandThe lock command installs the plugins sources and generates the lock file.
Rerunning this command will not reinstall plugin sources, just check that they
are all okay. It will always regenerate the lock file.
sh
sheldon lock
To force a reinstall of all plugin sources you can use the --reinstall flag.
sh
sheldon lock --reinstall
source commandThis command generates the shell script. This command will first check if there
is an up to date lock file, if not, then it will first do the equivalent of the
lock command above. This command is usually used with the built-in shell
source command.
sh
source <(sheldon source)
If we now modify our config file and run this command again it will relock the configuration prior to generating the script. The output of this command is highly configurable. You can define your own custom templates to apply to your plugins.
add commandThis command adds a new plugin to the config file. It does nothing else but edit the config file. In the following command we add a GitHub repository as a source.
sh
sheldon add my-repo --git http://github.com/owner/repo.git
An example usage of this command for each source type is shown in the Configuration: plugin sources section.
edit commandThis command will open the config file in the default editor and only overwrite
the contents if the updated config file is valid. To override the editor that is
used you should set the EDITOR environment variable.
For example using vim
sh
EDITOR=vim sheldon edit
Or with Visual Studio Code
sh
EDITOR="code --wait" sheldon edit
remove commandThis command removes a plugin from the config file. In the following command we
remove the plugin with name my-repo.
sh
sheldon remove my-repo
sheldon accepts the following global command line flags.
| Flag | Description |
| ----------------- | --------------------------------- |
| -q, --quiet | Suppress any informational output |
| -v, --verbose | Use verbose output |
| --no-color | Do not use ANSI colored output |
| -h, --help | Show the help message and exit |
| -V, --version | Show the version and exit |
sheldon accepts the following global command line options.
| Option | Environment variable | Description |
| ----------------------- | ---------------------- | ----------------------------------------------------------- |
| --home <path> | HOME | Set the home directory. (default: auto) |
| --root <path> | SHELDON_ROOT | Set the root directory. (default: <home>/.sheldon) |
| --config-file <path> | SHELDON_CONFIG_FILE | Set the config file. (default: <root>/plugins.toml) |
| --lock-file <path> | SHELDON_LOCK_FILE | Set the lock file. (default: <config-file>.lock) |
| --clone-dir <path> | SHELDON_CLONE_DIR | Set the clone directory. (default: <root>/repos) |
| --download-dir <path> | SHELDON_DOWNLOAD_DIR | Set the download directory. (default: <root>/downloads) |
The priority order for setting these values is the following
A plugin is defined by adding a new unique name to the plugins table in the
[TOML] config file. This can be done by either editing the file directly or
using the provided sheldon commands. A plugin must the location of the
source. There are three types of sources, each kind is described in this
section. A plugin may only specify one source type.
```toml
[plugins.oh-my-zsh] github = "robbyrussell/oh-my-zsh"
```
Git sources specify a remote Git repository that will be cloned to the sheldon root directory. There are three flavors of Git sources.
githubA GitHub source must set the github field and specify the repository. This
should be the username or organization and the repository name separated by a
forward slash. Add the following to the sheldon config file.
toml
[plugins.pure]
github = "sindresorhus/pure"
Or run sheldon add with the --github option.
sh
sheldon add pure --github sindresorhus/pure
gistA Gist source must set the gist field and specify the repository. This should
be the hash or username and hash of the Gist. Add the following to the
sheldon config file.
toml
[plugins.pure]
gist = "579d02802b1cc17baed07753d09f5009"
Or run sheldon add with the --gist option.
sh
sheldon add pure --gist 579d02802b1cc17baed07753d09f5009
gitA Git source must set the git field and specify the URL to clone. Add the
following to the sheldon config file.
toml
[plugins.pure]
git = "https://github.com/sindresorhus/pure"
Or run sheldon add with the --git option.
sh
sheldon add pure --git https://github.com/sindresorhus/pure
All Git sources also allow setting of one of the branch, tag or rev
fields. sheldon will then checkout the repository at this reference.
toml
[plugins.pure]
github = "sindresorhus/pure"
tag = "v1.12.0"
Or run sheldon add with the --tag, --branch, or --rev option when
adding the plugin.
sh
sheldon add pure --github sindresorhus/pure --tag v1.12.0
GitHub and Gist sources are cloned using HTTPS by default. You can specify that
Git or SSH should be used by setting the proto field to the protocol type.
This must be one of git, https, or ssh.
toml
[plugins.pure]
github = "sindresorhus/pure"
proto = "ssh"
For a plain Git source you should specify the URL with a git:// or ssh://.
For SSH you will need to specify the username as well (it is git for GitHub).
toml
[plugins.pure]
git = "ssh://git@github.com/sindresorhus/pure"
Currently sheldon only supports authentication when cloning using SSH and only with authentication via the SSH agent. This means if you have a plugin source that is a private repository you will have to use the SSH protocol for cloning.
Remote sources specify a remote file that will be downloaded to the sheldon
root directory. A Remote source must set the remote field and specify the
URL. Add the following to the sheldon config file.
toml
[plugins.pure]
remote = "https://github.com/rossmacarthur/pure/raw/master/pure.zsh"
Or run sheldon add with the --remote option.
sh
sheldon add pure --remote https://github.com/rossmacarthur/pure/raw/master/pure.zsh
Local sources reference local directories. A Local source must set the local
field and specify a directory. Tildes may be used and will be expanded to the
current user's home directory. Add the following to the sheldon config file.
toml
[plugins.pure]
local = "~/Downloads/repos/pure"
Or run sheldon add with the --local option.
sh
sheldon add pure --local '~/Downloads/repos/pure'
These are options that are common to all the above plugins.
useA list of files / globs to use in the plugin's source directory. If this field
is not given then the first pattern in the global match field that
matches any files will be used. Add the following to the sheldon config
file.
toml
[plugins.pure]
github = "sindresorhus/pure"
use = ["*.zsh"]
Or run sheldon add with the --use option when adding the plugin.
sh
sheldon add pure --github sindresorhus/pure --use '*.zsh'
applyA list of template names to apply to this plugin. This defaults to the global
apply.
toml
[plugins.pure]
github = "sindresorhus/pure"
apply = ["source", "PATH"]
Or run sheldon add with the --apply option when adding the plugin.
sh
sheldon add pure --github sindresorhus/pure --apply source PATH
You can define your own custom templates to apply to your plugins.
For convenience it also possible to define Inline plugins. An Inline plugin must
set the inline field and specify the raw source.
toml
[plugins.pure]
inline = """
pure() {
echo 'not really :P'
}
"""
A template is a string that represents a generic action to take on a plugin. For
example the PATH template adds the plugin directory to the shell PATH
variable. A plugin will apply a template if you add the template name to the
apply field on a plugin.
Available built in templates are
PATH variable.FPATH variable.path variable.fpath variable.As template strings they could be represented like this
toml
[templates]
source = { value = 'source "{{ file }}"', each = true }
PATH = 'export PATH="{{ dir }}:$PATH"'
FPATH = 'export FPATH="{{ dir }}:$FPATH"'
path = 'path=( "{{ dir }}" $path )'
fpath = 'fpath=( "{{ dir }}" $fpath )'
For example if we change the apply field for the below plugin, it will only
add the plugin directory to the PATH and append it to the fpath. The plugin
will not be sourced.
toml
[plugins.pure]
source = "github"
repository = "sindresorhus/pure"
apply = ["PATH", "fpath"]
The each value, as used in the source template above, specifies that the
template should be applied to each matched file for the plugin. This defaults to
false.
It is possible to create your own custom templates, and you can even override the built in ones.
Plugins all have the following information that can be used in templates
{{ name }}.{{ dir }}.match field or specified as a plugin
option with use. These can be used in templates using {{ file }}.You can use the following global information in templates
{{ root }}.Lets say we would like a template to symlink files into the
~/.sheldon/functions directory. We could create a new template with name
function, like this
toml
[templates]
function = { value = 'ln -sf "{{ file }}" "~/.sheldon/functions/{{ name }}"', each = true }
It can then be applied to the plugin like this
toml
[plugins.pure]
github = "sindresorhus/pure"
apply = ["function"]
The built in PATH template adds the directory path to the beginning of the
PATH variable, we might want to change it to the be added at the end. We could
do this like this
toml
[templates]
PATH = 'export PATH="$PATH:{{ dir }}"'
You can then apply it to the plugin like this
toml
[plugins.pure]
github = "sindresorhus/pure"
apply = ["source", "PATH"]
Note: this would change the behavior of PATH for all plugins using it.
matchA list of glob patterns to match against a plugin's contents. The first pattern
that matches any files will be used by default as a plugin's use field. This
defaults to
toml
match = [
"{{ name }}.plugin.zsh",
"{{ name }}.zsh",
"{{ name }}.sh",
"{{ name }}.zsh-theme",
"*.plugin.zsh",
"*.zsh",
"*.sh",
"*.zsh-theme",
]
Note: if you are not using [Zsh] then you should probably change this setting.
applyA list of template names to apply to all plugins by default (see
apply). This defaults to
toml
apply = ["source"]
Licensed under either of
at your option.