mirror of
https://github.com/jorgebucaran/fisher
synced 2024-11-09 07:10:27 +00:00
54212e1cbc
* Improved README, added links to screencasts, updated documentation with new changes and fixed other typos and composition errors. * Removed `fisher update --cache` in favor of `fisher --cache | fisher update` and `fisher uninstall --all` in favor of `fisher --cache | fisher uninstall`. * Fisherman does not move initialization / configuration files following the convention `name`.config.fish to `$fisher_config/functions`, but to `$fisher_config/conf.d` now and evaluates each `*.config.fish` inside at shell start as usual. Closes #13. * Added `fisher --cache[=base]` option to retrieve contents in `$fisher_cache`, eliminating flaky usage of `find(1)`. Closes #11. * Fisherman now generates information about plugins installed via custom URLs. For the description, a shortened version of the URL is used. For the URL the full URL is used. For tags, the URL is fuzzily checked and tags such as _theme_, _plugin_, _config_ and _omf_ are added. The tag _orphan_ is added by default as well. Finally, the author is generated by retrieving the e-mail or username of the author of the first commit in the plugin's repository. Closes #9 and #14. * Changed `--path-in-cache` to `--translate.` This function translates an name or supported URL/URL variation into a path inside `$fisher_cache`. This allows you to treat plugins installed via custom URLs almost like regular plugins if they are installed. Closes #8. * Fixed a bug with `mktemp` failing on some systems. Closes #7. Thanks @tobywf. * Added [CODE_OF_CONDUCT][code_of_conduct]. Closes #6. * Fisherman can now unload themes within the same shell, without having to restart the session. Closes #5. * Fisherman can now load themes within the same shell, without having to restart the session using `exec fish`. Shoddy themes, for example those failing to declare global variables with the `-g` flag still require the session to be reset. See [**related**][bobthefish-19]. Closes #4. * Move `getopts` implementation to `share/getopts.awk`. Closes #3. * Support dots inside URIs in `fisher --validate`. Closes #2.
140 lines
3.7 KiB
Groff
140 lines
3.7 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER" "1" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\fR \- fish plugin manager
|
|
.
|
|
.SH "SYNOPSIS"
|
|
\fBfisher\fR \fIcommand\fR [\fIoptions\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
|
|
.
|
|
.br
|
|
\fBfisher\fR \fB\-\-file\fR=\fIfishfile\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR \fB\-\-validate\fR=\fIname\fR or \fIurl\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR \fB\-\-cache\fR[=\fIpath\fR]
|
|
.
|
|
.br
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Fisherman is a plugin manager for \fBfish\fR(1) that lets you share and reuse code, prompts and configurations easily\.
|
|
.
|
|
.P
|
|
The following commands are available: \fIinstall\fR, \fIuninstall\fR, \fIupdate\fR, \fIsearch\fR and \fIhelp\fR\. See \fBfisher\fR help \fIcommand\fR for information about each command\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB\-f\fR \fB\-\-file\fR=\fIfishfile\fR: Read \fIfishfile\fR and write contents to standard output\. If \fIfishfile\fR is null or an empty string, your user \fIfishfile\fR in \fB$fisher_config\fR/fishfile will be used instead\. Use a dash \fB\-\fR to force reading from the standard input\. Oh My Fish! bundle files are supported as well\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB\-V\fR, \fB\-\-validate\fR=\fIkeyword\fR: Validate a \fIname\fR or \fIurl\fR\. If \fIkeyword\fR resembles a url, the algorithm will attempt to normalize the url by adding / removing missing components\. Otherwise, it will assume \fIkeyword\fR is a potential plugin name and use the following regex \fB^[a\-z]+[\._\-]?[a\-z0\-9]+\fR to validate the string\. This method is used internally to validate user input and support url variations such as \fIowner/repo\fR, \fIgh:owner/repo\fR, \fIbb:owner/repo\fR, etc\. See \fBfisher\fR(7)#{\fBPlugins\fR}\.
|
|
.
|
|
.IP
|
|
If \fIkeyword\fR is null or an empty string, \fB\-\-validate\fR reads keyword\fIs\fR from the standard input\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB\-\-cache\fR[=\fIbase\fR] Retrieve the path of every plugin downloaded to \fB$fisher_cache\fR\. Includes plugins installed using a custom URL\. Use \-\-cache=\fIbase\fR to select only the name of the plugin\. See \fBbasename\fR(1)\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB\-v\fR \fB\-\-version\fR: Show version information\. Fisherman\'s current version can be found in the VERSION file at the root of the project\. The version scheme is based in \fBSemantic Versioning\fR and uses Git annotated tags to track releases\.
|
|
.
|
|
.IP "\(bu" 4
|
|
\fB\-h\fR \fB\-\-help\fR: Show usage help\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "CUSTOM COMMANDS"
|
|
A Fisherman command is a function that you can invoke using the \fBfisher\fR utility\. By convention, any function of the form \fBfisher_<my_command>\fR is registered as Fisherman command\. You can create plugins that add new commands as well as regular utilities\. See \fBfisher help commands\fR and \fBfisher help plugins\fR for more information\.
|
|
.
|
|
.SH "EXAMPLES"
|
|
.
|
|
.IP "\(bu" 4
|
|
Install a plugin\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher install fishtape
|
|
fishtape \-\-help
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.TP
|
|
Install plugins from a fishfile or bundle:
|
|
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher \-\-file=path/to/shared/fishfile | fisher install
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Validate a url\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
echo a/b | fisher \-V
|
|
> https://github\.com/a/b
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "AUTHORS"
|
|
Fisherman was created and it is currently maintained by Jorge Bucaran \fIj@bucaran\.me\fR\.
|
|
.
|
|
.P
|
|
See AUTHORS file for a more complete list of contributors\.
|
|
.
|
|
.SH "SEE ALSO"
|
|
\fBfisher\fR(7)
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIhelp\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIupdate\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIsearch\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIconfig\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIinstall\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIplugins\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIcommands\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIfishfile\fR
|
|
.
|
|
.br
|
|
\fBfisher\fR help \fIuninstall\fR
|
|
.
|
|
.br
|
|
|