Skip to content

tetzng/pez

Repository files navigation

pez

A lockfile-backed plugin manager for fish.

pez installs fish plugins from Git repositories or local paths, copies their fish assets into the standard config directories, and records the exact installed state in pez-lock.toml.

Status: experimental. Back up your fish config before migrating, and verify the result with pez doctor before removing another plugin manager.

Why pez?

  • Lockfile state for installed commits and copied files
  • GitHub shorthand, host-prefixed repos, full Git URLs, and local plugin paths
  • doctor checks for missing files, duplicate destinations, and theme assets
  • doctor, files, list --outdated, upgrade, and prune commands for routine maintenance
  • A guided migration path from fisher

Install

Use a prebuilt binary from GitHub Releases when one is available.

With Cargo:

cargo install pez

From this checkout:

cargo install --path .

With Nix flakes:

nix run github:tetzng/pez -- --version

More options: docs/install.md

Quick Start

Create the config file:

pez init

Add a plugin to pez.toml:

[[plugins]]
repo = "owner/repo"

Install and inspect:

pez install
pez list --format table
pez doctor

Install a single plugin directly:

pez install owner/repo
pez install gitlab.com/owner/repo@branch:main
pez install ./local-plugin

Enable hooks in the current shell when plugins rely on conf.d events:

pez activate fish | source

Persist that activation from ~/.config/fish/config.fish inside an interactive-shell guard.

Migrate from fisher

Use the low-risk path:

pez activate fish | source
pez migrate
pez install
pez list --format table
pez doctor

Only remove fisher after the migrated setup looks correct.

Details: docs/migrate-from-fisher.md

Docs

Security

pez installs code from third-party repositories into your fish configuration. It does not verify signatures or sandbox plugin code. Install plugins you trust, review migration changes before removing fisher, and keep pez doctor in your verification flow.

License

MIT

About

A lockfile-backed plugin manager for fish.

Topics

Resources

License

Stars

Watchers

Forks

Contributors