Sheldon

https://sheldon.cli.rs/
Admin
Sheldon is a fast, configurable command-line tool that manages shell plugins by specifying them in a...
Tokens:22,338
Snippets:168
Trust Score:6.3
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Sheldon with cargo-binstall

Source: https://sheldon.cli.rs/Installation

Installs the Sheldon CLI using cargo-binstall, which downloads release artifacts directly from GitHub.

```bash
cargo binstall sheldon
```

--------------------------------

### Install Sheldon using Pre-built Binaries Script

Source: https://sheldon.cli.rs/Installation

Automatically detects the host system, downloads the correct Sheldon binary artifact from GitHub releases, and extracts it to a specified directory.

```bash
curl --proto '=https' -fLsS https://rossmacarthur.github.io/install/crate.sh \
    | bash -s -- --repo rossmacarthur/sheldon --to ~/.local/bin
```

--------------------------------

### Build Sheldon from Source

Source: https://sheldon.cli.rs/Installation

Builds the Sheldon CLI from source code. Requires Rust and Cargo to be installed. The binary will be located in `target/release/sheldon`.

```bash
git clone https://github.com/rossmacarthur/sheldon.git
cd sheldon
cargo build --release
```

--------------------------------

### Sheldon CLI: Compact Release Profile Installation

Source: https://sheldon.cli.rs/print

Illustrates how to install Sheldon using the `compact` release profile, which is optimized for binary size, via Cargo.

```shell
cargo install --profile compact sheldon
```

--------------------------------

### Sheldon Configuration File Example

Source: https://sheldon.cli.rs/print

An example of a Sheldon plugins configuration file written in TOML format, specifying a plugin from a GitHub repository.

```toml
# ~/.config/sheldon/plugins.toml

[plugins.base16]
github = "chriskempson/base16-shell"

```

--------------------------------

### Install Sheldon with Nix

Source: https://sheldon.cli.rs/Installation

Installs the Sheldon CLI using Nix package manager. This command adds Sheldon to your Nix profile.

```bash
nix profile install "github:rossmacarthur/sheldon"
```

--------------------------------

### Adding zsh-syntax-highlighting Plugin

Source: https://sheldon.cli.rs/Examples

Provides instructions for adding the zsh-syntax-highlighting plugin using Sheldon, covering both manual TOML configuration and the `sheldon add` command.

```toml
[plugins.zsh-syntax-highlighting]
github = "zsh-users/zsh-syntax-highlighting"

```

```bash
sheldon add zsh-syntax-highlighting --github zsh-users/zsh-syntax-highlighting

```

--------------------------------

### Add z.lua plugin

Source: https://sheldon.cli.rs/Examples

Shows how to add the z.lua plugin to Sheldon, either through the config file or the command line.

```toml
[plugins."z.lua"]
github = "skywind3000/z.lua"

```

```bash
sheldon add z.lua --github skywind3000/z.lua

```

--------------------------------

### Add powerlevel10k theme

Source: https://sheldon.cli.rs/Examples

Shows how to add the powerlevel10k Zsh theme using Sheldon, either by editing the config or using the command.

```toml
[plugins.powerlevel10k]
github = "romkatv/powerlevel10k"

```

```bash
sheldon add powerlevel10k --github romkatv/powerlevel10k

```

--------------------------------

### Cargo BInstall Installation

Source: https://sheldon.cli.rs/print

Installs Sheldon using cargo-binstall, which downloads release artifacts directly from GitHub releases.

```bash
cargo binstall sheldon
```

--------------------------------

### Compact Release Profile Installation (Bash)

Source: https://sheldon.cli.rs/RELEASES

Shows the command to install Sheldon using the `compact` release profile, which is optimized for binary size. This was introduced in version 0.7.1.

```bash
cargo install --profile compact sheldon
```

--------------------------------

### Nix Installation

Source: https://sheldon.cli.rs/print

Installs Sheldon using the Nix package manager by adding it to your user profile.

```nix
nix profile install "github:rossmacarthur/sheldon"
```

--------------------------------

### Add spaceship-prompt theme

Source: https://sheldon.cli.rs/Examples

Demonstrates adding the spaceship-prompt Zsh theme with Sheldon, via config file or command line.

```toml
[plugins.spaceship]
github = "spaceship-prompt/spaceship-prompt"

```

```bash
sheldon add spaceship --github spaceship-prompt/spaceship-prompt

```

--------------------------------

### Cargo Installation with Feature Flags

Source: https://sheldon.cli.rs/print

Installs the Sheldon CLI using Cargo, with the ability to enable specific features. This example demonstrates installing with vendored OpenSSL.

```bash
cargo install sheldon --features vendored-openssl
```

--------------------------------

### Install Sheldon with Homebrew

Source: https://sheldon.cli.rs/Installation

Installs the Sheldon CLI using the Homebrew package manager on macOS and Linux.

```bash
brew install sheldon
```

--------------------------------

### Building Sheldon from Source

Source: https://sheldon.cli.rs/print

Instructions for building Sheldon from its source code using Cargo. Requires Rust and Cargo to be installed.

```bash
git clone https://github.com/rossmacarthur/sheldon.git
cd sheldon
cargo build --release
```

--------------------------------

### Adding Oh My Zsh Plugin

Source: https://sheldon.cli.rs/Examples

Instructions for adding the Oh My Zsh framework as a plugin using Sheldon. This includes both manual configuration file addition and using the `sheldon add` command, along with the necessary `~/.zshrc` configuration.

```toml
[plugins.oh-my-zsh]
github = "ohmyzsh/ohmyzsh"

```

```bash
sheldon add oh-my-zsh --github "ohmyzsh/ohmyzsh"

```

```bash
# ~/.zshrc

export ZSH="$HOME/.local/share/sheldon/repos/github.com/ohmyzsh/ohmyzsh"

# Oh My Zsh settings here

eval "$(sheldon source)"

```

--------------------------------

### Sheldon CLI - Shell Configuration Example

Source: https://sheldon.cli.rs/Configuration

Examples demonstrating how to configure the default shell environment for the Sheldon CLI. This setting influences various global configurations, including default match patterns and available templates.

```toml
shell = "bash"
```

```toml
shell = "zsh"
```

--------------------------------

### Add enhancd plugin

Source: https://sheldon.cli.rs/Examples

Provides instructions for adding the enhancd plugin to Sheldon via config file or command.

```toml
[plugins.enhancd]
github = "b4b4r07/enhancd"

```

```bash
sheldon add enhancd --github b4b4r07/enhancd

```

--------------------------------

### Add Plugin Example

Source: https://sheldon.cli.rs/print

Demonstrates how to add a plugin from a GitHub repository using the 'sheldon add' command. It specifies a unique name for the plugin and the GitHub repository URL.

```bash
sheldon add base16 --github chriskempson/base16-shell
```

```bash
sheldon add my-repo --git https://github.com/owner/repo.git
```

--------------------------------

### Adding autojump Plugin

Source: https://sheldon.cli.rs/Examples

Instructions for integrating the autojump plugin with Sheldon. This includes configuring the plugin, specifying the directory, and applying the PATH and source templates. Both TOML configuration and command-line usage are provided.

```toml
[plugins.autojump]
github = "wting/autojump"
dir = "bin"
apply = ["PATH", "source"]

```

```bash
sheldon add autojump --github wting/autojump --dir bin --apply PATH source

```

--------------------------------

### Sheldon CLI - Cargo Installation with Features

Source: https://sheldon.cli.rs/RELEASES

This command shows how to install Sheldon using Cargo, the Rust package manager. It includes an example of enabling specific Cargo features, such as vendoring OpenSSL, to customize the build.

```bash
cargo install sheldon --features vendored-openssl
```

--------------------------------

### Add blackbox plugin

Source: https://sheldon.cli.rs/Examples

Demonstrates how to add the blackbox plugin to Sheldon by either modifying the config file or using the command line.

```toml
[plugins.blackbox]
github = "StackExchange/blackbox"

```

```bash
sheldon add blackbox --github StackExchange/blackbox

```

--------------------------------

### Add pure theme with custom use

Source: https://sheldon.cli.rs/Examples

Explains how to add the pure Zsh theme using Sheldon, including specifying custom files to use.

```toml
[plugins.pure]
github = "sindresorhus/pure"
use = ["async.zsh", "pure.zsh"]

```

```bash
sheldon add pure --github sindresorhus/pure --use async.zsh pure.zsh

```

--------------------------------

### Install Sheldon with Cargo

Source: https://sheldon.cli.rs/Installation

Installs the Sheldon CLI from Crates.io using Cargo, the Rust package manager. It can optionally use the Cargo.lock file.

```bash
cargo install sheldon
```

```bash
cargo install sheldon --locked
```

--------------------------------

### Sheldon CLI - Nix Flake Installation

Source: https://sheldon.cli.rs/RELEASES

This snippet demonstrates how to install Sheldon using Nix Flakes, a reproducible package management system. It allows users to install Sheldon directly from its GitHub repository.

```bash
nix profile install "github:rossmacarthur/sheldon"
```

--------------------------------

### Nix Flake Installation for Sheldon

Source: https://sheldon.cli.rs/print

Installs the Sheldon CLI using Nix, leveraging its flake support. This command adds the Sheldon repository to your Nix profile.

```nix
nix profile install "github:rossmacarthur/sheldon"
```

--------------------------------

### Automated Binary Download and Installation

Source: https://sheldon.cli.rs/print

A script to automatically detect the host system, download the correct Sheldon binary artifact, and extract it to a specified directory.

```sh
curl --proto '=https' -fLsS https://rossmacarthur.github.io/install/crate.sh \
    | bash -s -- --repo rossmacarthur/sheldon --to ~/.local/bin
```

--------------------------------

### Add base16-shell plugin

Source: https://sheldon.cli.rs/Examples

Illustrates how to add the base16-shell plugin to Sheldon, using either the config file or the command line.

```toml
[plugins.base16]
github = "chriskempson/base16-shell"

```

```bash
sheldon add base16 --github chriskempson/base16-shell

```

--------------------------------

### Sheldon Init Command

Source: https://sheldon.cli.rs/print

Adds a new `init` command to Sheldon for initializing a configuration file. This command simplifies the setup process for new users.

```bash
sheldon init

```

--------------------------------

### Plugin 'hooks' Configuration

Source: https://sheldon.cli.rs/Configuration

Specifies shell statements to be executed before ('pre') or after ('post') plugin installation.

```toml
[plugins.example]
github = "owner/repo"

[plugins.example.hooks]
pre = "export TEST=test"
post = "unset TEST"

```

--------------------------------

### Homebrew Installation

Source: https://sheldon.cli.rs/print

Installs Sheldon using the Homebrew package manager.

```shell
brew install sheldon
```

--------------------------------

### TOML Configuration for Base16 Shell Plugin

Source: https://sheldon.cli.rs/print

Example of how to define a plugin in the Sheldon TOML configuration file, specifically for the base16-shell plugin from GitHub.

```toml
# ~/.config/sheldon/plugins.toml

#           ┌─ Unique name for the plugin
#        ┌──┴─┐
[plugins.base16]
github = "chriskempson/base16-shell"
#         └─────┬────┘ └─────┬────┘
#               │            └─ GitHub repository name
#               └─ GitHub user or organization

```

--------------------------------

### TOML Configuration for Git Plugin Sources

Source: https://sheldon.cli.rs/print

Examples of configuring different Git-based plugin sources (GitHub, Gist, generic Git) in the Sheldon TOML configuration file.

```toml
[plugins.example]
github = "owner/repo"

```

```toml
[plugins.example]
gist = "579d02802b1cc17baed07753d09f5009"

```

```toml
[plugins.example]
git = "https://github.com/owner/repo"

```

```toml
[plugins.example]
github = "owner/repo"
tag = "v0.1.0"

```

--------------------------------

### Adding zsh-autosuggestions Plugin

Source: https://sheldon.cli.rs/Examples

Details on how to add the zsh-autosuggestions plugin using Sheldon. It covers manual configuration and the command-line method, including specifying the file to use.

```toml
[plugins.zsh-autosuggestions]
github = "zsh-users/zsh-autosuggestions"
use = ["{{ name }}.zsh"]

```

```bash
sheldon add zsh-autosuggestions --github zsh-users/zsh-autosuggestions --use '{{ name }}.zsh'

```

--------------------------------

### Plugin 'hooks' Configuration

Source: https://sheldon.cli.rs/print

Defines shell statements to be executed before ('pre') or after ('post') a plugin is installed.

```toml
[plugins.example]
github = "owner/repo"

[plugins.example.hooks]
pre = "export TEST=test"
post = "unset TEST"

```

--------------------------------

### Add autojump Plugin with Sheldon

Source: https://sheldon.cli.rs/print

This example shows how to integrate the autojump plugin with Sheldon. It includes configuration for the GitHub repository, the `dir` parameter to specify a directory to add to the PATH, and the `apply` parameter to specify how the plugin should be applied. Both TOML and bash commands are included.

```toml
[plugins.autojump]
github = "wting/autojump"
dir = "bin"
apply = ["PATH", "source"]

```

```bash
sheldon add autojump --github wting/autojump --dir bin --apply PATH source

```

--------------------------------

### Extended Glob Syntax Example

Source: https://sheldon.cli.rs/RELEASES

Demonstrates the use of extended glob syntax in Sheldon plugins, specifically showing how to exclude certain patterns like Git and NVM while including all other .zsh files.

```toml
[plugins.ohmyzsh]
github = "ohmyzsh/ohmyzsh"
dir = "lib"
use = ["{!git,!nvm,*}.zsh]


```

--------------------------------

### Cargo Installation

Source: https://sheldon.cli.rs/print

Installs Sheldon using Cargo, the Rust package manager. Includes an option to force the use of the Cargo.lock file.

```bash
cargo install sheldon
cargo install sheldon --locked
```

--------------------------------

### Add pure Theme with Sheldon

Source: https://sheldon.cli.rs/print

This example shows how to add the pure Zsh prompt theme using Sheldon. It specifies the GitHub repository and uses the `use` parameter to include specific files for the theme. Both TOML configuration and bash command are provided.

```toml
[plugins.pure]
github = "sindresorhus/pure"
use = ["async.zsh", "pure.zsh"]

```

```bash
sheldon add pure --github sindresorhus/pure --use async.zsh pure.zsh

```

--------------------------------

### Add blackbox Plugin with Sheldon

Source: https://sheldon.cli.rs/print

This example shows how to add the blackbox plugin using Sheldon. It specifies the GitHub repository for the plugin. Both the TOML configuration and the bash command are provided.

```toml
[plugins.blackbox]
github = "StackExchange/blackbox"

```

```bash
sheldon add blackbox --github StackExchange/blackbox

```

--------------------------------

### Add powerlevel10k Theme with Sheldon

Source: https://sheldon.cli.rs/print

This example shows how to add the powerlevel10k Zsh theme using Sheldon. It specifies the GitHub repository for the theme. Both the TOML configuration and the bash command are provided.

```toml
[plugins.powerlevel10k]
github = "romkatv/powerlevel10k"

```

```bash
sheldon add powerlevel10k --github romkatv/powerlevel10k

```

--------------------------------

### Template Syntax Migration

Source: https://sheldon.cli.rs/RELEASES

Demonstrates the change in template syntax from Handlebars to Jinja-like templating in Sheldon. The example shows how to convert a template that used the `each` field to a new format using a `for` loop.

```toml
[templates]
defer = { value = 'zsh-defer source "{{ file }}"', each = true }

```

```toml
[templates]
defer = "{% for file in files %}"
zsh-defer source "{{ file }}"
{% endfor %}"

```

--------------------------------

### Lock and Source Plugins

Source: https://sheldon.cli.rs/Command-line-interface

The `lock` command installs plugin sources and generates a lock file. Rerunning it verifies installations and regenerates the lock file. The `source` command generates shell scripts, first ensuring an up-to-date lock file. It's typically used with `eval`.

```bash
sheldon lock
sheldon lock --update
sheldon lock --reinstall
eval "$(sheldon source)"
```

--------------------------------

### Add enhancd Plugin with Sheldon

Source: https://sheldon.cli.rs/print

This example shows how to add the enhancd plugin using Sheldon. It specifies the GitHub repository for the plugin. Both the TOML configuration and the bash command are provided.

```toml
[plugins.enhancd]
github = "b4b4r07/enhancd"

```

```bash
sheldon add enhancd --github b4b4r07/enhancd

```

--------------------------------

### Deferred Loading of Zsh Plugins with zsh-defer

Source: https://sheldon.cli.rs/Examples

Demonstrates how to configure Sheldon to use zsh-defer for deferred loading of Zsh plugins. This involves adding zsh-defer as a plugin and defining a custom 'defer' template. The zsh-defer plugin definition must precede plugins that use the 'defer' template.

```toml
[plugins.zsh-defer]
github = "romkatv/zsh-defer"

```

```toml
[templates]
defer = "{{ hooks?.pre | nl }}{% for file in files %}zsh-defer source \"{{ file }}\"\n{% endfor %}{{ hooks?.post | nl }}"

```

```toml
[plugins.zsh-syntax-highlighting]
github = "zsh-users/zsh-syntax-highlighting"
apply = ["defer"]

```

--------------------------------

### Load Sheldon Plugins

Source: https://sheldon.cli.rs/Getting-started

Loads installed Sheldon plugins into your current shell session. This involves sourcing the output of the `sheldon source` command in your shell's configuration file (e.g., `~/.zshrc`, `~/.bashrc`).

```bash
# ~/.zshrc or ~/.bashrc

eval "$(sheldon source)"
```

--------------------------------

### Sheldon Template Configuration with Configurable Hooks

Source: https://sheldon.cli.rs/print

Illustrates how to configure custom hooks (e.g., 'pre', 'post') for Sheldon plugins within the configuration file. This example shows setting a 'post' hook for the 'enhancd' plugin and updating a 'defer' template to use these hooks.

```toml
[plugins.enhancd]
github = "b4b4r07/enhancd"

[plugins.enhancd.hooks]
post = 'export ENHANCD_HOOK_AFTER_CD = "ls"'

[templates]
defer = "{{ hooks | get: \"pre\" | nl }}{% for file in files %}zsh-defer source \"{{ file }}\"\n{% endfor %}{{ hooks | get: \"post\" | nl }}"
```

--------------------------------

### Sheldon Migration Table

Source: https://sheldon.cli.rs/RELEASES

Provides a migration guide for users updating Sheldon, detailing changes in configuration and data paths, environment variables, CLI options, and template variables due to the adoption of the XDG directory structure and removal of the root directory.

```APIDOC
Sheldon Migration Guide:

This table outlines the changes in paths, environment variables, and CLI options following the adoption of the XDG directory structure and the removal of the `root` directory in Sheldon version 0.6.0.

| Old Path/Variable/Option | New Path/Variable/Option |
|---|---|
| Config paths: `<root>/plugins.toml` | `<config_dir>/plugins.toml` |
| Data paths: `<root>/plugins.lock` | `<data_dir>/plugins.lock` |
| `<root>/repos` | `<data_dir>/repos` |
| `<root>/downloads` | `<data_data>/downloads` |
| Env variables: `SHELDON_ROOT` | `SHELDON_CONFIG_DIR` |
|  | `SHELDON_DATA_DIR` |
| CLI options: `--root` | `--config-dir` |
|  | `--data-dir` |
| Template variables: `{{ root }}` | `{{ data_dir }}` |

Note: If you used Sheldon's defaults, your configuration will remain unchanged. For custom configurations, please refer to this table for necessary updates.
```

--------------------------------

### Sheldon CLI Shell Completions

Source: https://sheldon.cli.rs/print

Generates shell completion scripts for various shells supported by clap. This example shows how to generate completions for the Fish shell.

```bash
sheldon completions --shell fish
```

--------------------------------

### Extended Glob Syntax Support in Sheldon

Source: https://sheldon.cli.rs/print

Introduces support for extended glob patterns like `{a,b}` and `!` in Sheldon's configuration. This allows for more flexible file matching in plugin configurations. The example demonstrates using these patterns to exclude specific files.

```toml
[plugins.ohmyzsh]
github = "ohmyzsh/ohmyzsh"
dir = "lib"
use = ["{!git,!nvm,*}.zsh]

```

--------------------------------

### Sheldon CLI Version Output with Git and Rustc Info

Source: https://sheldon.cli.rs/print

Starting from version 0.6.1, the Sheldon CLI embeds Git and Rustc information into the binary. This information is displayed when the `--version` flag is used, providing details about the build environment.

```shell
sheldon --version
# Example Output:
# sheldon 0.6.1
# git: <commit_hash>
# rustc: <rustc_version>
```

--------------------------------

### Lock and Source Plugins

Source: https://sheldon.cli.rs/print

Illustrates the commands for managing plugin sources and generating shell scripts. 'sheldon lock' installs sources and generates a lock file, while 'eval "$(sheldon source)"' integrates the sourced script into the current shell session.

```bash
sheldon lock
```

```bash
sheldon lock --update
```

```bash
sheldon lock --reinstall
```

```bash
eval "$(sheldon source)"
```

--------------------------------

### Sheldon CLI: Experimental Fish Shell Support

Source: https://sheldon.cli.rs/print

Shows how to initialize Sheldon for the Fish shell, enabling tailored global matches and templates. It also includes the command to evaluate Sheldon's source in the Fish configuration.

```shell
sheldon init --shell fish
eval "$(sheldon source)"
```

--------------------------------

### Initialize Sheldon CLI

Source: https://sheldon.cli.rs/Getting-started

Initializes the Sheldon configuration file (`plugins.toml`). You can specify the shell type (e.g., bash, zsh) to generate appropriate sourcing commands.

```bash
sheldon init --shell bash
```

```zsh
sheldon init --shell zsh
```

--------------------------------

### Generate Shell Completions

Source: https://sheldon.cli.rs/Command-line-interface

Generates shell completion scripts for Bash and Zsh. These scripts help in autocompleting Sheldon commands in the terminal. If Sheldon is installed via Homebrew, completions might be installed automatically. Otherwise, they can be generated manually.

```bash
sheldon completions --shell bash > /path/to/completions/sheldon.bash
```

```zsh
sheldon completions --shell zsh > /path/to/_sheldon
```

--------------------------------

### Fish Shell Support (Bash)

Source: https://sheldon.cli.rs/RELEASES

Demonstrates initializing Sheldon for the Fish shell, including the necessary configuration for Fish shell startup files. This experimental feature was added in version 0.7.2.

```bash
sheldon init --shell fish

eval "$(sheldon source)"
```

--------------------------------

### Sheldon CLI 'init' Command

Source: https://sheldon.cli.rs/RELEASES

Introduces the 'init' command for Sheldon CLI, which initializes a configuration file. Running `sheldon init` creates a default configuration file, typically at `~/.sheldon/plugins.toml`.

```rust
sheldon init
```

--------------------------------

### Generate Shell Completions

Source: https://sheldon.cli.rs/print

Generates shell completion scripts for Bash and Zsh. These can be output to stdout and redirected to a file for installation.

```bash
sheldon completions --shell bash > /path/to/completions/sheldon.bash
```

```zsh
sheldon completions --shell zsh > /path/to/completions/_sheldon
```

--------------------------------

### Command Line Options for Directories

Source: https://sheldon.cli.rs/print

Describes the addition of `--clone-dir` and `--download-dir` command-line options in Sheldon v0.4.7. These options allow users to configure the directories for cloning Git sources and downloading remote sources. Environment variables are also supported.

```rust
--clone-dir <directory>
--download-dir <directory>
```

--------------------------------

### Sheldon CLI Feature: Configurable Clone and Download Directories

Source: https://sheldon.cli.rs/RELEASES

Introduces `--clone-dir` and `--download-dir` options to configure where Git plugin sources are cloned and remote sources are downloaded. Environment variables for these options are also supported.

```rust
# Add `--clone-dir` and `--download-dir` options.
# The directories where Git plugin sources are cloned to, and remote sources are downloaded to, are now configurable.
# Environment variables for setting these options are also now available.
```

--------------------------------

### Adding a Git Plugin via TOML and CLI

Source: https://sheldon.cli.rs/Configuration

Demonstrates how to add a plugin from a Git repository using both the TOML configuration file and the Sheldon CLI command.

```toml
[plugins.example]
git = "https://github.com/owner/repo"

```

```bash
sheldon add example --git https://github.com/owner/repo

```

--------------------------------

### Custom Template for Deferred Loading (Zsh)

Source: https://sheldon.cli.rs/print

Defines a custom 'defer' template that uses 'zsh-defer' to load plugins asynchronously. This improves Zsh startup speed.

```toml
[templates]
defer = "{{ hooks?.pre | nl }}{% for file in files %}zsh-defer source \"{{ file }}\"\n{% endfor %}{{ hooks?.post | nl }}"
```

--------------------------------

### Applying Deferred Loading to a Plugin

Source: https://sheldon.cli.rs/print

Applies the custom 'defer' template to a specific plugin ('zsh-syntax-highlighting') to enable deferred loading.

```toml
[plugins.zsh-syntax-highlighting]
github = "zsh-users/zsh-syntax-highlighting"
apply = ["defer"]
```

--------------------------------

### Sheldon CLI Migration for Root and Clone Directories

Source: https://sheldon.cli.rs/RELEASES

Provides instructions for migrating Sheldon's default root and clone directories. It includes commands to move existing directories and environment variables to preserve old behavior.

```bash
mv ~/.zsh ~/.sheldon
mv ~/.sheldon/repositories ~/.sheldon/repos

export SHELDON_ROOT="$HOME/.zsh"
export SHELDON_CLONE_DIR="$SHELDON_ROOT/repositories"
```

--------------------------------

### Overriding the PATH Template

Source: https://sheldon.cli.rs/Examples

Shows how to override the default PATH template in Sheldon to append directories to the PATH variable instead of prepending them. This change affects all plugins that utilize the PATH template.

```toml
[templates]
PATH = 'export PATH="$PATH:{{ dir }}"'

```

```toml
[plugins.example]
github = "owner/repo"
apply = ["source", "PATH"]

```

--------------------------------

### Adding a GitHub Plugin via TOML and CLI

Source: https://sheldon.cli.rs/Configuration

Illustrates how to add a plugin from a GitHub repository using both the TOML configuration file and the Sheldon CLI command.

```toml
[plugins.example]
github = "owner/repo"

```

```bash
sheldon add example --github owner/repo

```

--------------------------------

### Non-Interactive Mode (Bash)

Source: https://sheldon.cli.rs/RELEASES

Illustrates how to use the `--non-interactive` option in the Sheldon CLI to suppress prompts. This global option must be specified before the subcommand, as shown in the example for initializing the Zsh shell.

```bash
sheldon --non-interactive init --shell zsh
```

--------------------------------

### Initialize Sheldon Configuration

Source: https://sheldon.cli.rs/print

Shows how to initialize a new Sheldon configuration file. It can also specify the shell for which to initialize the configuration.

```bash
sheldon init
```

```bash
sheldon init --shell bash
```

```bash
sheldon init --shell zsh
```

--------------------------------

### Sheldon Template Configuration with Optional Access

Source: https://sheldon.cli.rs/print

Demonstrates updating custom Sheldon templates to use optional access syntax (`.?`) for safer field access within templates. This example shows a 'defer' template update.

```toml
[templates]
defer = "{{ hooks?.pre | nl }}{% for file in files %}zsh-defer source \"{{ file }}\"\n{% endfor %}{{ hooks?.post | nl }}"
```

--------------------------------

### Adding a Gist Plugin via TOML and CLI

Source: https://sheldon.cli.rs/Configuration

Shows how to add a plugin from a GitHub Gist using both the TOML configuration file and the Sheldon CLI command.

```toml
[plugins.example]
gist = "579d02802b1cc17baed07753d09f5009"

```

```bash
sheldon add example --gist 579d02802b1cc17baed07753d09f5009

```

--------------------------------

### Sheldon CLI: Conditional Plugin Sourcing with Profiles

Source: https://sheldon.cli.rs/print

Shows how to specify profiles for plugins in Sheldon's configuration. Plugins with a `profiles` key will only be included when Sheldon is run with a matching profile, specified via a command-line flag or environment variable.

```toml
[plugins.example]
github = "owner/repo"
profiles = ["<name>"]
```

--------------------------------

### Adding a Remote Plugin via TOML and CLI

Source: https://sheldon.cli.rs/Configuration

Shows how to add a plugin from a remote URL using both the TOML configuration file and the Sheldon CLI command.

```toml
[plugins.example]
remote = "https://github.com/owner/repo/raw/branch/plugin.zsh"

```

```bash
sheldon add example --remote https://github.com/owner/repo/raw/branch/plugin.zsh

```

--------------------------------

### Add Plugin via GitHub Repository

Source: https://sheldon.cli.rs/print

Demonstrates adding a plugin to Sheldon using the `sheldon add` command with the `--github` option, specifying the owner and repository name.

```shell
sheldon add example --github owner/repo
```

--------------------------------

### Plugin 'apply' Option (Config File)

Source: https://sheldon.cli.rs/print

Specifies a list of template names to apply to a plugin. Defaults to the global 'apply' setting.

```toml
[plugins.example]
github = "owner/repo"
apply = ["source", "PATH"]

```

--------------------------------

### Local Source Configuration

Source: https://sheldon.cli.rs/Configuration

Configures a local source for a Sheldon plugin, referencing a local directory. Tildes are expanded to the user's home directory.

```toml
[plugins.example]
local = "~/Downloads/plugin"

```

--------------------------------

### Manage Plugins

Source: https://sheldon.cli.rs/Command-line-interface

Commands for adding, editing, and removing plugins from the Sheldon configuration file. `add` takes a repository URL, `edit` opens the config in an editor, and `remove` takes the plugin name.

```bash
sheldon add my-repo --git https://github.com/owner/repo.git
EDITOR=vim sheldon edit
EDITOR="code --wait" sheldon edit
sheldon remove my-repo
```

--------------------------------

### Sheldon Initialization Script

Source: https://sheldon.cli.rs/print

This snippet shows how to integrate Sheldon into your shell's configuration file (e.g., .zshrc or .bashrc) to enable its functionality.

```bash
eval "$(sheldon source)"
```

--------------------------------

### Cloning with Git or SSH Protocols

Source: https://sheldon.cli.rs/Configuration

Details how to specify the cloning protocol (git, https, ssh) for GitHub and Gist sources, and how to use SSH URLs for plain Git sources.

```toml
[plugins.example]
github = "owner/repo"
proto = "ssh"

```

```toml
[plugins.example]
git = "ssh://git@github.com/owner/repo"

```

--------------------------------

### Add and Remove Config Commands

Source: https://sheldon.cli.rs/print

Demonstrates how to add and remove plugins from the Sheldon configuration file using the `add` and `remove` commands. The `add` command takes plugin details like name, GitHub repository, and tag, while `remove` takes the plugin name.

```rust
sheldon add example --github owner/repo --tag v0.1.0
```

```rust
sheldon remove example
```

--------------------------------

### Add zsh-syntax-highlighting Plugin with Sheldon

Source: https://sheldon.cli.rs/print

This snippet illustrates adding the zsh-syntax-highlighting plugin via Sheldon. It specifies the GitHub repository for the plugin. Both the TOML configuration and the corresponding bash command are provided.

```toml
[plugins.zsh-syntax-highlighting]
github = "zsh-users/zsh-syntax-highlighting"

```

```bash
sheldon add zsh-syntax-highlighting --github zsh-users/zsh-syntax-highlighting

```

--------------------------------

### Sheldon CLI Feature: Directory Key for Plugins

Source: https://sheldon.cli.rs/RELEASES

Allows configuration of the plugin directory as a subdirectory of the source, providing more flexibility in organizing plugin files.

```rust
# Support directory key for plugins.
# The plugin directory can now be configured to be a sub directory of the source.
```

--------------------------------

### Sheldon Initialization

Source: https://sheldon.cli.rs/print

Initializes the Sheldon configuration file (`plugins.toml`) for either bash or zsh shells.

```bash
sheldon init --shell bash
sheldon init --shell zsh
```

--------------------------------

### Add Plugin via Gist

Source: https://sheldon.cli.rs/print

Shows how to add a plugin to Sheldon using the `sheldon add` command with the `--gist` option, providing the Gist hash.

```shell
sheldon add example --gist 579d02802b1cc17baed07753d09f5009
```

--------------------------------

### Applying Multiple Templates (Config File)

Source: https://sheldon.cli.rs/print

Configures a plugin to use multiple templates ('PATH', 'fpath') by specifying them in the 'apply' field, affecting how the plugin directory is integrated into the shell environment.

```toml
[plugins.example]
github = "owner/repo"
apply = ["PATH", "fpath"]

```

--------------------------------

### Add spaceship Theme with Sheldon

Source: https://sheldon.cli.rs/print

This snippet demonstrates adding the spaceship prompt theme using Sheldon. It specifies the GitHub repository for the theme. Both the TOML configuration and the bash command are provided.

```toml
[plugins.spaceship]
github = "spaceship-prompt/spaceship-prompt"

```

```bash
sheldon add spaceship --github spaceship-prompt/spaceship-prompt

```

--------------------------------

### Plugin 'apply' Option Configuration

Source: https://sheldon.cli.rs/Configuration

Defines a list of template names to apply to a plugin. Defaults to the global 'apply' field.

```toml
[plugins.example]
github = "owner/repo"
apply = ["source", "PATH"]

```

--------------------------------

### Plugin 'use' Option (Config File)

Source: https://sheldon.cli.rs/print

Configures which files or globs within a plugin's source directory should be used. Defaults to global 'match' patterns if not specified.

```toml
[plugins.example]
github = "owner/repo"
use = ["*.zsh"]

```

--------------------------------

### Sheldon CLI 'add' and 'remove' Commands

Source: https://sheldon.cli.rs/RELEASES

Demonstrates how to use the 'add' and 'remove' commands to manage plugins in the Sheldon configuration file. The 'add' command takes a plugin name, source (e.g., GitHub), and tag, while 'remove' takes the plugin name to delete it.

```rust
sheldon add example --github owner/repo --tag v0.1.0

[plugins.example]
github = "owner/repo"
tag = "v0.1.0"

sheldon remove example
```

--------------------------------

### Adding Plugin with 'apply' Option via CLI

Source: https://sheldon.cli.rs/Configuration

Adds a Sheldon plugin via the CLI, specifying templates to apply with the --apply option.

```bash
sheldon add example --github owner/repo --apply source PATH

```

--------------------------------

### Plugin 'apply' Option (CLI)

Source: https://sheldon.cli.rs/print

Adds a plugin using the Sheldon CLI with the '--apply' option to specify which templates should be applied to the plugin.

```bash
sheldon add example --github owner/repo --apply source PATH

```

--------------------------------

### Plugin 'use' Option Configuration

Source: https://sheldon.cli.rs/Configuration

Specifies files or globs to use within a plugin's source directory. If not provided, it falls back to the global 'match' field.

```toml
[plugins.example]
github = "owner/repo"
use = ["*.zsh"]

```

--------------------------------

### Sheldon CLI Options

Source: https://sheldon.cli.rs/Command-line-interface

Defines command-line arguments for configuring Sheldon, such as setting the configuration directory, data directory, config file path, and specifying a profile for plugin matching. These options can also be controlled via environment variables.

```APIDOC
--config-dir <path>
  Environment variable: SHELDON_CONFIG_DIR
  Set the config directory where the configuration file will be stored. This defaults to $XDG_CONFIG_HOME/sheldon or ~/.config/sheldon.

--data-dir <path>
  Environment variable: SHELDON_DATA_DIR
  Set the data directory where plugins will be downloaded to. This defaults to $XDG_DATA_HOME/sheldon or ~/.local/share/sheldon.

--config-file <path>
  Environment variable: SHELDON_CONFIG_FILE
  Set the path to the config file. This defaults to <config-dir>/plugins.toml where <config-dir> is the config directory.

--profile <profile>
  Environment variable: SHELDON_PROFILE
  Specify the profile to match plugins against. Plugins which have profiles configured will only get loaded if one of the given profiles matches the profile.
```
Tokens:
Raw