mirror of
https://github.com/jorgebucaran/fisher
synced 2024-07-06 23:11:48 +02:00
42 lines
1.7 KiB
Markdown
42 lines
1.7 KiB
Markdown
|
fisher-fishfile(5) -- Fishfile Format
|
||
|
|
=====================================
|
||
|
|
|
||
|
|
## SYNOPSIS
|
||
|
|
|
||
|
|
A fishfile lets you share plugin configurations across multiple installations, allows plugins to declare dependencies, and prevent information loss in case of system failure.
|
||
|
|
|
||
|
|
Fisherman also keeps a user *fishfile* in `$fisher_config`/fishfile which is automatically updated as you install or uninstall plugins.
|
||
|
|
|
||
|
|
## USAGE
|
||
|
|
|
||
|
|
Fishfiles are plain text, manifest files that list one or more plugins by their name, url or short url `owner/repo`.
|
||
|
|
|
||
|
|
Here is an example:
|
||
|
|
|
||
|
|
```
|
||
|
|
# my plugins
|
||
|
|
gitio
|
||
|
|
fishtape
|
||
|
|
|
||
|
|
# other links
|
||
|
|
oh-my-fish/bobthefish
|
||
|
|
```
|
||
|
|
|
||
|
|
To read fishfiles use `fisher --file`=*fishfile*. This utility reads fishfiles sequentially, writing them to standard output. Oh My Fish! bundle files are supported too.
|
||
|
|
|
||
|
|
If *fishfile* is null or an empty string, the global *fishfile* in `$fisher_config`/fishfile is used instead. Use a dash `-` to force read from standard input.
|
||
|
|
|
||
|
|
## PLUGINS
|
||
|
|
|
||
|
|
Plugins may declare any number of dependencies to other plugins in a fishfile at the root of their project.
|
||
|
|
|
||
|
|
By default, when Fisherman installs a plugin, it will also fetch and install its dependencies. If a dependency is already installed, it will not be updated as this could potentially break other plugins using an older version. For the same reason, uninstalling a plugin does not remove its dependencies.
|
||
|
|
|
||
|
|
To understand this behavior, it helps to recall the shell's single scope for functions. The lack of private functions means that, it is *not* possible to single-lock a specific dependency version. See also `fisher`(7)#{`Flat Tree`}.
|
||
|
|
|
||
|
|
## SEE ALSO
|
||
|
|
|
||
|
|
`fisher`(1)<br>
|
||
|
|
`fisher help config`<br>
|
||
|
|
`fisher`(7) #{`Flat Tree`}<br>
|