mirror of
https://github.com/jorgebucaran/fisher
synced 2024-07-02 23:11:48 +02:00
ebec1eaa01
* Deprecate fisher --list in favor of a new command fisher list. The behavior is roughly the same. See fisher help list for usage. tl;dr: Use list to query the local system / cache and search to query the index. * Teach fisher_plugin_walk about fish_postexec, fish_command_not_found and fish_preexec event emitters and erase them during uninstall if they were defined in a snippet. * Fisherman now recognizes the following aliases by default: i for install, u for update, l for list, s for search and h for help. * Large documentation rewrite. Better, simpler, more concise and more consistent. * Fisherman now detects if users have modified their fish prompt using fish_config and if so, uninstalls $fisher_prompt.
159 lines
3 KiB
Groff
159 lines
3 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-INSTALL" "1" "February 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-install\fR \- Install plugins
|
|
.
|
|
.SH "SYNOPSIS"
|
|
fisher install [\fIplugins\fR \.\.\.] [\-\-force] [\-\-quiet] [\-\-help]
|
|
.
|
|
.SH "USAGE"
|
|
fisher install \fIurl\fR
|
|
.
|
|
.br
|
|
fisher install \fIname\fR
|
|
.
|
|
.br
|
|
fisher install \fIpath\fR
|
|
.
|
|
.br
|
|
fisher install \fIowner/repo\fR
|
|
.
|
|
.br
|
|
fisher install \fIfunction\fR
|
|
.
|
|
.br
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Install one or more plugins, by name, URL, path or function name\. If no arguments are given, read the standard input\.
|
|
.
|
|
.P
|
|
In addition, all of the following owner/repo variations are accepted:
|
|
.
|
|
.IP "\(bu" 4
|
|
owner/repo \fIhttps://github\.com/owner/repo\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
github/owner/repo \fIhttps://github\.com/owner/repo\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
gh/owner/repo \fIhttps://github\.com/owner/repo\fR
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Shortcuts to other common Git repository hosting services are also available:
|
|
.
|
|
.IP "\(bu" 4
|
|
bb/owner/repo \fIhttps://bitbucket\.org/owner/repo\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
gl/owner/repo \fIhttps://gitlab\.com/owner/repo\fR
|
|
.
|
|
.IP "\(bu" 4
|
|
omf/owner/repo \fIhttps://github\.com/oh\-my\-fish/repo\fR
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
If a URL is given, the repository is cloned to $fisher_cache the first time and any relevant plugin files are copied to $fisher_config functions, completions, conf\.d and man directories\.
|
|
.
|
|
.P
|
|
If the plugin already exists in $fisher_cache, the files are only copied to $fisher_config\. To update a plugin use fisher update\.
|
|
.
|
|
.P
|
|
If the plugin declares dependencies, these will be installed too\. If any of the dependencies are already enabled or downloaded to the cache, they will not be updated to prevent version issues\.
|
|
.
|
|
.P
|
|
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\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.TP
|
|
\-f, \-\-force
|
|
Reinstall given plugin/s\.
|
|
.
|
|
.TP
|
|
\-q, \-\-quiet
|
|
Enable quiet mode\.
|
|
.
|
|
.TP
|
|
\-h, \-\-help
|
|
Show usage help\.
|
|
.
|
|
.SH "DIRECTORY TREE"
|
|
The directory tree in \fImy_plugin\fR
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
my_plugin
|
|
|\-\- README\.md
|
|
|\-\- my_plugin\.fish
|
|
|\-\- functions
|
|
| `\-\- my_plugin_helper\.fish
|
|
|\-\- completions
|
|
| `\-\- my_plugin\.fish
|
|
|\-\- test
|
|
| `\-\- my_plugin\.fish
|
|
`\-\- man
|
|
`\-\- man1
|
|
`\-\- my_plugin\.1
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
The directory tree in $fisher_config after running fisher install my_plugin:
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
$fisher_config
|
|
|\-\- functions
|
|
| |\-\- my_plugin\.fish
|
|
| `\-\- my_plugin_helper\.fish
|
|
|\-\- completions
|
|
| `\-\- my_plugin\.fish
|
|
|\-\- man
|
|
| `\-\- man1
|
|
| `\-\- my_plugin\.1
|
|
`\-\- cache
|
|
|\-\- my_other_plugin
|
|
`\-\- my_plugin/\.\.\.
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "SNIPPETS"
|
|
Snippets are plugins that run code at the start of the shell\. Snippets must be placed inside a sub directory named conf\.d\.
|
|
.
|
|
.SH "EXAMPLES"
|
|
.
|
|
.IP "\(bu" 4
|
|
Install plugins from multiple sources\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher install fishtape simnalamburt/shellder ~/plugins/my_plugin
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "SEE ALSO"
|
|
fisher help uninstall
|
|
.
|
|
.br
|
|
|