A plugin manager for Fish.
Manage functions, completions, bindings, and snippets from the command line. Extend your shell capabilities, change the look of your prompt and create repeatable configurations across different systems effortlessly.
curl -sL https://git.io/fisher | source && fisher install jorgebucaran/fisher
You can install, update, and remove plugins interactively with Fisher, taking advantage of Fish tab completion and rich syntax highlighting.
Install plugins using the
installcommand followed by the path to the repository on GitHub.
fisher install ilancosman/tide
To get a specific version of a plugin add an
@symbol after the plugin name followed by a tag, branch, or commit.
fisher install jorgebucaran/[email protected]
You can install plugins from a local directory too.
fisher install ~/path/to/plugin
Fisher expands plugins into your Fish configuration directory by default, overwriting existing files. If you wish to change this behavior, set$fisher_pathto your preferred location and put it in your function path (#640).
List all the plugins that are currently installed using the
$ fisher list jorgebucaran/fisher ilancosman/tide jorgebucaran/[email protected] /home/jb/path/to/plugin
listcommand also accepts a regular expression to filter the output.
$ fisher list \^/ /home/jb/path/to/plugin
updatecommand updates one or more plugins to their latest version.
fisher update jorgebucaran/fisher
Use justfisher updateto update everything.
Remove installed plugins using the
fisher remove jorgebucaran/[email protected]
You may want to remove everything, including Fisher.
fisher list | fisher remove
Whenever you install or remove a plugin from the command line, Fisher will write down all the installed plugins plugins to
$__fish_config_dir/fish_plugins. Adding this file to your dotfiles or version control is the easiest way to share your configuration across different systems.
You can also edit this file and run
fisher updateto commit changes:
jorgebucaran/fisher ilancosman/tide jorgebucaran/[email protected] + PatrickF1/fzf.fish - /home/jb/path/to/plugin
That will install PatrickF1/fzf.fish, remove /home/jb/path/to/plugin, and update everything else.
A plugin can be any number of files in a
completionsdirectory. Most plugins consist of a single function, or configuration snippet. This is what a typical plugin looks like.
ponyo ├── completions │ └── ponyo.fish ├── conf.d │ └── ponyo.fish └── functions └── ponyo.fish
.fishfiles as well as directories inside those locations will be copied to
Plugins are notified as they are being installed, updated, or removed via Fish events.
--on-eventfunctions must already be loaded when their event is emitted. Thus, you should put your event handlers in theconf.ddirectory.
# Defined in ponyo/conf.d/ponyo.fish
function _ponyo_install --on-event ponyo_install # Set universal variables, create bindings, and other initialization logic. end
function _ponyo_update --on-event ponyo_update # Migrate resources, print warnings, and other update logic. end
function _ponyo_uninstall --on-event ponyo_uninstall # Erase "private" functions, variables, bindings, and other uninstall logic. end
Fisher started out in 2016 by @jorgebucaran as a shell configuration manager for Fish. We had a lot of help along the way. Oh My Fish laid the groundwork as the first popular Fish framework. @jethrokuan was particularly helpful during the first years. @PatrickF1's candid feedback has been invaluable time and again. Bootstrapping Fisher was originally @IlanCosman's idea. Thank you to all our contributors! <3