fisher/man/man1/fisher-install.md

fisher-install(1) -- Enable / Install plugins

SYNOPSIS

fisher install [name or url ...] [--quiet] [--help]

USAGE

fisher install plugin ...
fisher install owner/repo ...

DESCRIPTION

Install one or more plugins by name, searching $fisher_index or by url. If no arguments are given, read the standard input.

If a copy of the plugin already exists in $fisher_cache, the relevant files are copied to $fisher_config/functions, otherwise the plugin repository is first downloaded. If you wish to update a plugin, use fisher update instead.

If the plugin declares any dependencies, they will be installed as well. If any dependencies are already installed they will not be updated in order to prevent mismatching version issues. See fisher help fishfile#{Plugins}.

If a plugin includes either a fish_prompt.fish or fish_right_prompt.fish, both files are first removed from $fisher_config/functions and then the new ones are copied.

OPTIONS

• -q --quiet: Enable quiet mode.

• -h --help: Show usage help.

PROCESS

Here is a typical install process breakdown for plugin:

1. Check if plugin exists in $fisher_index. Fail otherwise.
2. Download plugin to $fisher_cache if it is not there already.
3. Copy all *.fish and functions/*.fish files to $fisher_config/functions.
4. Copy all completions/*.fish to $fisher_config/completions.
5. Copy all man/man[1-7] to $fisher_config/man/man%

Here is the plugin tree inside the cache:

$fisher_cache/plugin
|-- README.md
|-- plugin.fish
|-- functions
| |-- plugin_helper.fish
|-- completions
| |-- plugin.fish
|-- test
| |-- plugin.fish
|-- man
|-- man1
|-- plugin.1

And here is how files are copied from $fisher_cache/plugin to $fisher_config:

1. plugin.fish -> $fisher_config/functions
2. functions/plugin_helper.fish -> $fisher_config/functions
3. completions/plugin.fish -> $fisher_config/completions
4. man/man1/plugin.1 -> $fisher_config/man/man1

SEE ALSO

fisher(1)
fisher help config
fisher help update
fisher help uninstall
fisher help fishfile#{Plugins}