Skip to content

Latest commit

 

History

History
153 lines (103 loc) · 4.65 KB

README.md

File metadata and controls

153 lines (103 loc) · 4.65 KB
Raw

Fisher

A plugin manager for Fish—the friendly interactive shell.

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.

  • Zero configuration out of the box. Need to tweak a thing? You can do that too.
  • 100% pure Fish—easy to contribute to or modify.
  • Blazing fast concurrent plugin downloads.
  • Oh My Fish! plugin support.

Looking for plugins? Browse git.io/awsm.fish or search on GitHub.

Installation

curl -sL https://git.io/fisher | source && fisher install jorgebucaran/fisher

Quickstart

You can install, update, and remove plugins interactively with Fisher, taking advantage of Fish tab completion and rich syntax highlighting.

Installing plugins

Install plugins using the install command 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_path to your preferred location and put it in your function path.

Listing plugins

List all the plugins that are currently installed using the list command.

$ fisher list
jorgebucaran/fisher
ilancosman/tide
jorgebucaran/[email protected]
/home/jb/path/to/plugin

The list command also accepts a regular expression to filter the output.

$ fisher list \^/
/home/jb/path/to/plugin

Updating plugins

The update command updates one or more plugins to their latest version.

fisher update ilancosman/tide

Use fisher update to update everything, including Fisher.

Removing plugins

Remove installed plugins using the remove command.

fisher remove jorgebucaran/[email protected]

Someday you may want to remove everything, including Fisher.

fisher list | fisher remove

Using your fish_plugins file

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 update to commit changes. Here's an example:

nano $__fish_config_dir/fish_plugins
jorgebucaran/fisher
ilancosman/tide
+ jethrokuan/z
- jorgebucaran/[email protected]
/home/jb/path/to/plugin
fisher update

That will install jethrokuan/z, remove jorgebucaran/nvm.fish, and update everything else.

Creating a plugin

A plugin can be any number of files in a functions, conf.d, and/or completions directory. Most plugins consist of a single function, or configuration snippet. This is what a typical plugin looks like.

foobar
├── functions
│   └── foobar.fish
├── completions
│   └── foobar.fish
└── conf.d
    └── foobar.fish

Non .fish files as well as directories inside those locations will be copied to $fisher_path under functions, conf.d, or completions respectively.

Event system

Plugins are notified as they are being installed, updated, or removed via Fish events.

--on-event functions must already be loaded when their event is emitted. So, put your event handlers in the conf.d directory.

# Defined in foobar/conf.d/foobar.fish

function _foobar_install --on-event foobar_install
    # Set universal variables, create bindings, and other initialization logic.
end

function _foobar_update --on-event foobar_update
  # Migrate resources, print warnings, and other update logic.
end

function _foobar_uninstall --on-event foobar_uninstall
    # Erase "private" functions, variables, bindings, and other uninstall logic.
end

License

MIT