[][src]Crate sheldon

A fast, configurable, shell plugin manager.

Features

  • Can manage almost anything.
    • Any public Git repository.
      • Branch/tag/commit support.
      • Extra support for GitHub repositories.
      • Extra support for Gists.
    • Arbitrary remote files, simply specify the URL.
    • Local plugins, simply specify the directory path.
  • Highly configurable install methods using handlebars templating.
  • Super-fast parallel installation.
  • Configuration file using TOML syntax.
  • Uses a lock file for much faster loading of plugins.

Getting started

You can install the sheldon command line tool using

cargo install sheldon

Create a configuration file at ~/.zsh/plugins.toml.

[plugins.oh-my-zsh]
github = 'robbyrussell/oh-my-zsh'

Read up more about configuration here.

You can then use the source command to generate the script

# ~/.zshrc
source <(sheldon source)

Structs

Builder

A builder that is used to construct a Sheldon with specific settings.

Error

An error that can occur in this crate.

Sheldon

The main application.

Enums

ErrorKind

A kind of Error.

Type Definitions

Result

A custom result type to use in this crate.