mirror of
https://github.com/jorgebucaran/fisher
synced 2024-06-28 23:01:50 +02:00
dbf07b1709
- Introduce new event system. #526, #527 #573. - Deprecate `init.fish`, `uninstall.fish`, etc. #581 - No cache fallback, no plugin dependencies, no more private package hosts, and no more gitlab/bitbucket support. #464, #579 - Require fish 3.0, use newer fish features, e.g., use `wait` to implement concurrent downloads. - Rely less on external tools. No awk, no sed, no basename/dirname. Just mv, rm, cp, and mkdir. - Deprecate `fishfile` in favor of `fish_plugins`. This new file works like the old fishfile, but without comment support. See #524.
140 lines
4.1 KiB
Markdown
140 lines
4.1 KiB
Markdown
# Fisher
|
|
|
|
> A plugin manager for [fish](https://fishshell.com)—the friendly interactive shell.
|
|
|
|
Now you can 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.
|
|
|
|
- Oh My Fish! plugin support.
|
|
- Blazingly fast concurrent plugin downloads.
|
|
- 100% pure fish—easy to contribute to or modify.
|
|
- Zero configuration out of the box. Need to tweak a thing? [You can do that too](#using-your-fish_plugins-file).
|
|
|
|
Fishing for plugins? Browse [git.io/awesome.fish](https://git.io/awesome.fish) or [search](https://github.com/topics/fish-plugins) [on](https://github.com/topics/fish-package) [GitHub](https://github.com/topics/fish-plugin).
|
|
|
|
## Installation
|
|
|
|
```console
|
|
curl -sL 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](https://fishshell.com/docs/current/index.html#completion) and rich syntax highlighting.
|
|
|
|
### Installing plugins
|
|
|
|
Install plugins using the `install` command followed by the path to the repository on GitHub.
|
|
|
|
```console
|
|
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](https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefcommit-ishacommit-ishalsocommittish).
|
|
|
|
```console
|
|
fisher install jorgebucaran/nvm.fish@1.1.0
|
|
```
|
|
|
|
You can install plugins from a local directory too.
|
|
|
|
```console
|
|
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.
|
|
|
|
```console
|
|
$ fisher list
|
|
jorgebucaran/fisher
|
|
ilancosman/tide
|
|
jorgebucaran/nvm.fish@1.1.0
|
|
/home/jb/path/to/plugin
|
|
```
|
|
|
|
> `jorgebucaran/fisher` is listed because we installed it to start with!
|
|
|
|
The `list` command also accepts a regular expression to filter the output.
|
|
|
|
```console
|
|
$ fisher list \^/
|
|
/home/jb/path/to/plugin
|
|
```
|
|
|
|
### Updating plugins
|
|
|
|
The `update` command updates one or more plugins to their latest version.
|
|
|
|
```console
|
|
fisher update ilancosman/tide
|
|
```
|
|
|
|
> `fisher update` by itself will update everything, including Fisher.
|
|
|
|
### Removing plugins
|
|
|
|
Remove installed plugins using the `remove` command.
|
|
|
|
```console
|
|
fisher remove jorgebucaran/nvm.fish@1.1.0
|
|
```
|
|
|
|
Sometimes you may want to remove everything, including Fisher.
|
|
|
|
```console
|
|
fisher list | fisher remove
|
|
```
|
|
|
|
## Using your `fish_plugins` file
|
|
|
|
Whenever you install or remove a plugin from the command line, Fisher will write down your plugins to `~/.config/fish/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 your changes. Here's an example:
|
|
|
|
```console
|
|
nano ~/.config/fish/fishfile
|
|
```
|
|
|
|
```diff
|
|
jorgebucaran/fisher
|
|
ilancosman/tide
|
|
+ jethrokuan/z
|
|
- jorgebucaran/nvm.fish@1.1.0
|
|
/home/jb/path/to/plugin
|
|
```
|
|
|
|
```console
|
|
fisher update
|
|
```
|
|
|
|
That will install **jethrokuan/z**, remove **jorgebucaran/nvm.fish**, and update everything else.
|
|
|
|
## Event system
|
|
|
|
Fisher leverages the fish [event system](https://fishshell.com/docs/current/cmds/emit.html) to notify plugins when they are being installed, updated, or removed.
|
|
|
|
> `--on-event` functions must be loaded when their event is emitted. So put event handlers in your `conf.d` directory.
|
|
|
|
```fish
|
|
# Defined in conf.d/foobar.fish
|
|
|
|
function foobar_install --on-event foobar_install
|
|
# Set global variables, create bindings, and other install 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](LICENSE.md)
|