Features
- Can manage virtually anything.
- Any public Git repository.
- Branch / tag / commit support.
- Submodule support.
- First class support for GitHub repositories.
- First class support for Gists.
- Arbitrary remote scripts or binaries.
- Local plugins.
- Inline plugins.
- Any public Git repository.
- Highly configurable install methods using handlebars templating.
- Shell agnostic, with sensible defaults for Zsh.
- Super-fast parallel installation.
- Config file using TOML syntax.
- Uses a lock file for much faster loading of plugins.
- Clean
~/.zshrc
or~/.bashrc
(just add 1 line).
Table of Contents
- Installation
- Getting started
- Command line interface
- Configuration: plugin sources
- Configuration: plugin options
- Configuration: inline plugins
- Configuration: templates
- Configuration: global options
- License
Installation
Pre-built binaries
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.
|
Cargo
sheldon can be installed using cargo, the Rust package manager. Install cargo using rustup then run the following command to install or update sheldon.
Release notes
Please see all release notes here.
Getting started
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.
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.
# ~/.zshrc or ~/.bashrc
Command line interface
lock
command
The 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.
To force a reinstall of all plugin sources you can use the --reinstall
flag.
source
command
This 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.
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
command
This 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.
An example usage of this command for each source type is shown in the Configuration: plugin sources section.
edit
command
This 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
EDITOR=vim
Or with Visual Studio Code
EDITOR="code --wait"
remove
command
This command removes a plugin from the config file. In the following command we
remove the plugin with name my-repo
.
Flags
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 |
Options
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
- Command line option.
- Environment variable.
- Default value.
Configuration: plugin sources
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.
# ~/.sheldon/plugins.toml
# ┌─ Unique name for the plugin
# ┌───┴───┐
[]
= "robbyrussell/oh-my-zsh"
# └─────┬────┘ └───┬───┘
# │ └─ GitHub repository name
# └─ GitHub user or organization
Git
Git sources specify a remote Git repository that will be cloned to the sheldon root directory. There are three flavors of Git sources.
github
A 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.
[]
= "sindresorhus/pure"
Or run sheldon add with the --github
option.
gist
A 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.
[]
= "579d02802b1cc17baed07753d09f5009"
Or run sheldon add with the --gist
option.
git
A Git source must set the git
field and specify the URL to clone. Add the
following to the sheldon config file.
[]
= "https://github.com/sindresorhus/pure"
Or run sheldon add with the --git
option.
Specifying a branch, tag, or commit
All Git sources also allow setting of one of the branch
, tag
or rev
fields. sheldon will then checkout the repository at this reference.
[]
= "sindresorhus/pure"
= "v1.12.0"
Or run sheldon add with the --tag
, --branch
, or --rev
option when
adding the plugin.
Cloning with Git or SSH protocols
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
.
[]
= "sindresorhus/pure"
= "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).
[]
= "ssh://git@github.com/sindresorhus/pure"
Private Git repositories
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
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.
[]
= "https://github.com/rossmacarthur/pure/raw/master/pure.zsh"
Or run sheldon add with the --remote
option.
Local
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.
[]
= "~/Downloads/repos/pure"
Or run sheldon add with the --local
option.
Configuration: plugin options
These are options that are common to all the above plugins.
use
A 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.
[]
= "sindresorhus/pure"
= ["*.zsh"]
Or run sheldon add with the --use
option when adding the plugin.
apply
A list of template names to apply to this plugin. This defaults to the global
apply
.
[]
= "sindresorhus/pure"
= ["source", "PATH"]
Or run sheldon add with the --apply
option when adding the plugin.
You can define your own custom templates to apply to your plugins.
Configuration: inline plugins
For convenience it also possible to define Inline plugins. An Inline plugin must
set the inline
field and specify the raw source.
[]
= """
pure() {
echo 'not really :P'
}
"""
Configuration: templates
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
- source: source each file in a plugin.
- PATH: add the plugin directory to the
PATH
variable. - FPATH: add the plugin directory to the
FPATH
variable. - path: add the plugin directory to the
path
variable. - fpath: add the plugin directory to the
fpath
variable.
As template strings they could be represented like this
[]
= { = 'source "{{ file }}"', = true }
= 'export PATH="{{ dir }}:$PATH"'
= 'export FPATH="{{ dir }}:$FPATH"'
= 'path=( "{{ dir }}" $path )'
= '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.
[]
= "github"
= "sindresorhus/pure"
= ["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
.
Custom templates
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
- A unique name. This is completely arbitrary, and it is the value specified
for the plugin in the plugins table. However, it is often the name of the
plugin, so it can be useful to use this name in templates with
{{ name }}
. - A directory. In git sources this is the location of the cloned repository,
for local sources, it is the directory specified. This directory can be used
in templates with
{{ dir }}
. - Zero or more files. These are the matched files in the plugin directory
either discovered using the the global
match
field or specified as a plugin option withuse
. These can be used in templates using{{ file }}
.
You can use the following global information in templates
- The sheldon root. This folder can be used as
{{ root }}
.
Example: symlinking files
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
[]
= { = 'ln -sf "{{ file }}" "~/.sheldon/functions/{{ name }}"', = true }
It can then be applied to the plugin like this
[]
= "sindresorhus/pure"
= ["function"]
Example: overriding the PATH template
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
[]
= 'export PATH="$PATH:{{ dir }}"'
You can then apply it to the plugin like this
[]
= "sindresorhus/pure"
= ["source", "PATH"]
Note: this would change the behavior of PATH for all plugins using it.
Configuration: global options
match
A 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
= [
"{{ 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.
apply
A list of template names to apply to all plugins by default (see
apply
). This defaults to
= ["source"]
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.