2016-01-01 21:12:40 +00:00
. \" generated with Ronn/v0.7.3
. \" http://github.com/rtomayko/ronn/tree/0.7.3
.
2016-03-09 04:24:47 +00:00
.TH "FISHER" "1" "March 2016" "" "fisherman"
2016-01-01 21:12:40 +00:00
.
.SH "NAME"
2016-02-29 14:13:29 +00:00
\fB fisher\fR \- Fish plugin manager
2016-01-01 21:12:40 +00:00
.
.SH "SYNOPSIS"
2016-03-09 09:40:59 +00:00
fisher \fI command\fR [\fI options\fR ] [\- \- version] [\- \- help]
Fisherman v0.2.0
* 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.
2016-01-03 03:35:56 +00:00
.
.br
2016-01-01 21:12:40 +00:00
.
.SH "DESCRIPTION"
2016-02-29 14:13:29 +00:00
Fisherman is a plugin manager for fish\.
2016-01-01 21:12:40 +00:00
.
.P
2016-03-09 04:24:47 +00:00
The CLI consists of the following commands: \fI install\fR , \fI update\fR , \fI uninstall\fR , \fI list\fR , \fI search\fR and \fI help\fR \.
2016-01-01 21:12:40 +00:00
.
2016-02-29 14:13:29 +00:00
.SH "USAGE"
Run a command\.
2016-01-01 21:12:40 +00:00
.
2016-02-29 14:13:29 +00:00
.IP "" 4
.
.nf
2016-03-09 09:40:59 +00:00
fisher <command> [<options>]
2016-02-29 14:13:29 +00:00
.
.fi
.
.IP "" 0
.
.P
Get help about a command\.
.
.IP "" 4
.
.nf
fisher help <command>
.
.fi
.
.IP "" 0
.
.P
2016-03-09 09:40:59 +00:00
Fisherman knows the following aliases: \fI i\fR for install, \fI u\fR for update, \fI l\fR for list, \fI s\fR for search and \fI h\fR for help\.
2016-02-29 14:13:29 +00:00
.
.SH "OPTIONS"
2016-01-01 21:12:40 +00:00
.
Ahoy! Fisherman 0.3.0
* Fix a critical bug in the Makefile that was
incorrectly merging any existing user configuration
file and the generated Fisherman configuration.
Closes #21.
* Fix a bug in install and uninstall that was adding
plugin names to fishfiles instead of the URL when
interacting with custom URLs. Probably closes #23.
* Fix a bug in install, update and uninstall that
was displaying an incorrect plugin count if there
was at least on failure.
* Fix bug in `fisher install` that causes install
to fail even though it succeeds, due to `wait(1)`'s
behavior of returning `1` if there is any output to
standard error. Closes #20.
* Fix bug in `fisher uninstall` that was removing
plugins from the cache by mistake.
* Add feature to Makefile to download the index for
the first time in order to provide auto-complete
before the user can install/update/search, actions
which would case the index to be updated.
* Add link to Slack [room][wharf] in README. Thanks
@simnalamburt.
* Add new `$fisher_timeout` configuration variable
that lets you specify `curl(1)` `--max-time` option.
Without this, `curl` could hang for a long time if
you are in a bad connection.
* Add `fisher install --link` to allow installing
plugins creating a symbolic link to each of the
relevant files to be copied during the install
process. If you use ***`--link`*** to install a
plugin that is a _path to a directory_ or file, a
symbolic link to the directory will be created making
local testing more convenient as you are not required
to update the plugin's repository to test changes
within Fisherman. If you are testing using
[Fishtape][fishtape] you do not even need to reset
the shell session.
* Add `fisher --alias[=<command>=<alias>]` to simplify
creating new aliases for `fisher` commands. Use
`fisher --alias` without arguments to list the current
set of aliases. Also add auto-complete for aliases
to install, update or uninstall. Note that aliases
are **not** persisted this way. To save your aliases
use `$fisher_alias` as described in `fisher help
config`. Also note that aliases are only auto-complete
if you call `fisher --alias`. To auto-complete aliases
saved to `$fisher_alias` you can do `fisher --alias
(fisher --alias)`.
* Add short options for new and old fisher flags:
* `--file` → `-f` * `--list` → `-l` * `--alias`
→ `-a`
* Improve help message for failed installs. Closes
* Improve `fisher --validate` to automatically correct
common misspellings, for example when installing a
oh-my-fish package, one often types ohmyifsh.
* :point_up: Improve auto-complete performance by
extracting the implementation of the different
`fisher` flags to `__fisher_*` functions.
`completions/fisher.fish` relies heavily in
`fisher_search` to query what plugins are available
to install/update/uninstall. In this process, numerous
calls to `fisher --list` and `fisher --validate`,
etc., are made. Now, auto-complete does not have to
pay the penalty of entering `fisher`, parsing options,
etc. Closes #27. @namandistro
* Improve `fisher --help` output and show up until
now poorly documented ***`--list`***, ***`--file`***,
etc. flags consistently. Also display available
commands after `make install` to improve usability.
* Improve `fisher install` so that it checks whether
the plugin you are trying to install, if it is already
in the cache, is a symbolic link or not, and installs
it as if the `--link` flag was specified.
* Improve `fisher --validate` to retrieve the absolute
path to the closest directory of the given items if
they are valid local paths. Related #19.
* Improve install to not `git clone` local plugins
if a regular `path/to/file` is given to `fisher
install`. Instead, copy to the cache using `cp(1)`
and if `--link` is used, create a symlink.
* Improve `fisher --validate` to invalidate items
with repeated `.` and `-` and allow items that begin
with `/` or `./` to support installing plugins from
local paths. Related #19.
* Modify `fisher update` default behavior. Now this
command updates Fisherman by default. Use of `--self`
and `--me` is also **deprecated**. To read from the
standard input use a dash `-`. For example: `fisher
--list | fisher update -`. Closes #25.
* Rename `--cache` to more descriptive ***`--list`***.
Thanks @colstrom.
* Remove `fisher --cache=base` and make it return
the base names of all directories in the path by
default. To get the full path use printf `printf
"$fisher_cache/%s" (fisher --list)`
* Rename undocumented `fisher --translate` flag
(again) to `fisher --cache`. This function reads the
standard input for a name, URL or local path and
calculates the plugin's path relative to the cache.
For a name this is simple `$fisher_cache/<name>` for
an URL, retrieve the remote URL of every repository
until there is a match with the given URL and return
the path in the cache of that repository. Finally,
if the input is a
* Revert #3. The reason `getopts.fish` was in its
own file originally is because @bucaran wanted a
standalone, dependency free cli parser solution,
arguably slightly faster than having Awk read
`getopts.awk` for each use. The performance improvement
is negligible at best, but `getopts` is also used
by every single command and future commands and
plugins are very likely to use it as well, so we
so we might as well use the slightly faster version.
2016-01-07 17:44:28 +00:00
.TP
Ahoy!! Fisherman 1.0.0 :anchor:
* 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.
* Rewrite documentation to be simpler and more consistent.
* Fisherman can install "functions" now. If you have created
a function interactively, you can run fisher install name
of the function and a directory will be created in
$PWD/name of the function and installed as usual.
* Fisherman now detects if users have modified their fish
prompt using fish_config and if so, uninstalls $fisher_prompt.
* Search results now truncate plugin descriptions based in
the width of the terminal screen.
* Install/Update/Uninstall CLI was retouched.
Looking behind and Ahead
========================
On Jan, 1st, Fisherman 0.1.0 departed from the bay of
"my hard drive" and today 1.0.0 has finally shipped.
Things are still a little rough and knotty, what did
you think? But 1.0.0 means all the basic things are
here.
Internally, we may still push some large changes, more
robust tests; at ~300 there are still areas a bit dry.
On the outside, Fisherman will change little, I hope.
That's a feature. If you want a more colorful CLI,
concurrent updates, or another bit here and there,
we may work something out.
This release means more time to focus on the plugin
ecosystem, but the adventures are far from over.
2016-03-01 08:36:20 +00:00
\- v, \- \- version
Show version information\. Fisherman follows Semantic Versioning and uses Git annotated tags to track releases\.
Fisherman v0.2.0
* 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.
2016-01-03 03:35:56 +00:00
.
Ahoy! Fisherman 0.3.0
* Fix a critical bug in the Makefile that was
incorrectly merging any existing user configuration
file and the generated Fisherman configuration.
Closes #21.
* Fix a bug in install and uninstall that was adding
plugin names to fishfiles instead of the URL when
interacting with custom URLs. Probably closes #23.
* Fix a bug in install, update and uninstall that
was displaying an incorrect plugin count if there
was at least on failure.
* Fix bug in `fisher install` that causes install
to fail even though it succeeds, due to `wait(1)`'s
behavior of returning `1` if there is any output to
standard error. Closes #20.
* Fix bug in `fisher uninstall` that was removing
plugins from the cache by mistake.
* Add feature to Makefile to download the index for
the first time in order to provide auto-complete
before the user can install/update/search, actions
which would case the index to be updated.
* Add link to Slack [room][wharf] in README. Thanks
@simnalamburt.
* Add new `$fisher_timeout` configuration variable
that lets you specify `curl(1)` `--max-time` option.
Without this, `curl` could hang for a long time if
you are in a bad connection.
* Add `fisher install --link` to allow installing
plugins creating a symbolic link to each of the
relevant files to be copied during the install
process. If you use ***`--link`*** to install a
plugin that is a _path to a directory_ or file, a
symbolic link to the directory will be created making
local testing more convenient as you are not required
to update the plugin's repository to test changes
within Fisherman. If you are testing using
[Fishtape][fishtape] you do not even need to reset
the shell session.
* Add `fisher --alias[=<command>=<alias>]` to simplify
creating new aliases for `fisher` commands. Use
`fisher --alias` without arguments to list the current
set of aliases. Also add auto-complete for aliases
to install, update or uninstall. Note that aliases
are **not** persisted this way. To save your aliases
use `$fisher_alias` as described in `fisher help
config`. Also note that aliases are only auto-complete
if you call `fisher --alias`. To auto-complete aliases
saved to `$fisher_alias` you can do `fisher --alias
(fisher --alias)`.
* Add short options for new and old fisher flags:
* `--file` → `-f` * `--list` → `-l` * `--alias`
→ `-a`
* Improve help message for failed installs. Closes
* Improve `fisher --validate` to automatically correct
common misspellings, for example when installing a
oh-my-fish package, one often types ohmyifsh.
* :point_up: Improve auto-complete performance by
extracting the implementation of the different
`fisher` flags to `__fisher_*` functions.
`completions/fisher.fish` relies heavily in
`fisher_search` to query what plugins are available
to install/update/uninstall. In this process, numerous
calls to `fisher --list` and `fisher --validate`,
etc., are made. Now, auto-complete does not have to
pay the penalty of entering `fisher`, parsing options,
etc. Closes #27. @namandistro
* Improve `fisher --help` output and show up until
now poorly documented ***`--list`***, ***`--file`***,
etc. flags consistently. Also display available
commands after `make install` to improve usability.
* Improve `fisher install` so that it checks whether
the plugin you are trying to install, if it is already
in the cache, is a symbolic link or not, and installs
it as if the `--link` flag was specified.
* Improve `fisher --validate` to retrieve the absolute
path to the closest directory of the given items if
they are valid local paths. Related #19.
* Improve install to not `git clone` local plugins
if a regular `path/to/file` is given to `fisher
install`. Instead, copy to the cache using `cp(1)`
and if `--link` is used, create a symlink.
* Improve `fisher --validate` to invalidate items
with repeated `.` and `-` and allow items that begin
with `/` or `./` to support installing plugins from
local paths. Related #19.
* Modify `fisher update` default behavior. Now this
command updates Fisherman by default. Use of `--self`
and `--me` is also **deprecated**. To read from the
standard input use a dash `-`. For example: `fisher
--list | fisher update -`. Closes #25.
* Rename `--cache` to more descriptive ***`--list`***.
Thanks @colstrom.
* Remove `fisher --cache=base` and make it return
the base names of all directories in the path by
default. To get the full path use printf `printf
"$fisher_cache/%s" (fisher --list)`
* Rename undocumented `fisher --translate` flag
(again) to `fisher --cache`. This function reads the
standard input for a name, URL or local path and
calculates the plugin's path relative to the cache.
For a name this is simple `$fisher_cache/<name>` for
an URL, retrieve the remote URL of every repository
until there is a match with the given URL and return
the path in the cache of that repository. Finally,
if the input is a
* Revert #3. The reason `getopts.fish` was in its
own file originally is because @bucaran wanted a
standalone, dependency free cli parser solution,
arguably slightly faster than having Awk read
`getopts.awk` for each use. The performance improvement
is negligible at best, but `getopts` is also used
by every single command and future commands and
plugins are very likely to use it as well, so we
so we might as well use the slightly faster version.
2016-01-07 17:44:28 +00:00
.TP
Ahoy!! Fisherman 1.0.0 :anchor:
* 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.
* Rewrite documentation to be simpler and more consistent.
* Fisherman can install "functions" now. If you have created
a function interactively, you can run fisher install name
of the function and a directory will be created in
$PWD/name of the function and installed as usual.
* Fisherman now detects if users have modified their fish
prompt using fish_config and if so, uninstalls $fisher_prompt.
* Search results now truncate plugin descriptions based in
the width of the terminal screen.
* Install/Update/Uninstall CLI was retouched.
Looking behind and Ahead
========================
On Jan, 1st, Fisherman 0.1.0 departed from the bay of
"my hard drive" and today 1.0.0 has finally shipped.
Things are still a little rough and knotty, what did
you think? But 1.0.0 means all the basic things are
here.
Internally, we may still push some large changes, more
robust tests; at ~300 there are still areas a bit dry.
On the outside, Fisherman will change little, I hope.
That's a feature. If you want a more colorful CLI,
concurrent updates, or another bit here and there,
we may work something out.
This release means more time to focus on the plugin
ecosystem, but the adventures are far from over.
2016-03-01 08:36:20 +00:00
\- h, \- \- help
Ahoy! Fisherman 0.3.0
* Fix a critical bug in the Makefile that was
incorrectly merging any existing user configuration
file and the generated Fisherman configuration.
Closes #21.
* Fix a bug in install and uninstall that was adding
plugin names to fishfiles instead of the URL when
interacting with custom URLs. Probably closes #23.
* Fix a bug in install, update and uninstall that
was displaying an incorrect plugin count if there
was at least on failure.
* Fix bug in `fisher install` that causes install
to fail even though it succeeds, due to `wait(1)`'s
behavior of returning `1` if there is any output to
standard error. Closes #20.
* Fix bug in `fisher uninstall` that was removing
plugins from the cache by mistake.
* Add feature to Makefile to download the index for
the first time in order to provide auto-complete
before the user can install/update/search, actions
which would case the index to be updated.
* Add link to Slack [room][wharf] in README. Thanks
@simnalamburt.
* Add new `$fisher_timeout` configuration variable
that lets you specify `curl(1)` `--max-time` option.
Without this, `curl` could hang for a long time if
you are in a bad connection.
* Add `fisher install --link` to allow installing
plugins creating a symbolic link to each of the
relevant files to be copied during the install
process. If you use ***`--link`*** to install a
plugin that is a _path to a directory_ or file, a
symbolic link to the directory will be created making
local testing more convenient as you are not required
to update the plugin's repository to test changes
within Fisherman. If you are testing using
[Fishtape][fishtape] you do not even need to reset
the shell session.
* Add `fisher --alias[=<command>=<alias>]` to simplify
creating new aliases for `fisher` commands. Use
`fisher --alias` without arguments to list the current
set of aliases. Also add auto-complete for aliases
to install, update or uninstall. Note that aliases
are **not** persisted this way. To save your aliases
use `$fisher_alias` as described in `fisher help
config`. Also note that aliases are only auto-complete
if you call `fisher --alias`. To auto-complete aliases
saved to `$fisher_alias` you can do `fisher --alias
(fisher --alias)`.
* Add short options for new and old fisher flags:
* `--file` → `-f` * `--list` → `-l` * `--alias`
→ `-a`
* Improve help message for failed installs. Closes
* Improve `fisher --validate` to automatically correct
common misspellings, for example when installing a
oh-my-fish package, one often types ohmyifsh.
* :point_up: Improve auto-complete performance by
extracting the implementation of the different
`fisher` flags to `__fisher_*` functions.
`completions/fisher.fish` relies heavily in
`fisher_search` to query what plugins are available
to install/update/uninstall. In this process, numerous
calls to `fisher --list` and `fisher --validate`,
etc., are made. Now, auto-complete does not have to
pay the penalty of entering `fisher`, parsing options,
etc. Closes #27. @namandistro
* Improve `fisher --help` output and show up until
now poorly documented ***`--list`***, ***`--file`***,
etc. flags consistently. Also display available
commands after `make install` to improve usability.
* Improve `fisher install` so that it checks whether
the plugin you are trying to install, if it is already
in the cache, is a symbolic link or not, and installs
it as if the `--link` flag was specified.
* Improve `fisher --validate` to retrieve the absolute
path to the closest directory of the given items if
they are valid local paths. Related #19.
* Improve install to not `git clone` local plugins
if a regular `path/to/file` is given to `fisher
install`. Instead, copy to the cache using `cp(1)`
and if `--link` is used, create a symlink.
* Improve `fisher --validate` to invalidate items
with repeated `.` and `-` and allow items that begin
with `/` or `./` to support installing plugins from
local paths. Related #19.
* Modify `fisher update` default behavior. Now this
command updates Fisherman by default. Use of `--self`
and `--me` is also **deprecated**. To read from the
standard input use a dash `-`. For example: `fisher
--list | fisher update -`. Closes #25.
* Rename `--cache` to more descriptive ***`--list`***.
Thanks @colstrom.
* Remove `fisher --cache=base` and make it return
the base names of all directories in the path by
default. To get the full path use printf `printf
"$fisher_cache/%s" (fisher --list)`
* Rename undocumented `fisher --translate` flag
(again) to `fisher --cache`. This function reads the
standard input for a name, URL or local path and
calculates the plugin's path relative to the cache.
For a name this is simple `$fisher_cache/<name>` for
an URL, retrieve the remote URL of every repository
until there is a match with the given URL and return
the path in the cache of that repository. Finally,
if the input is a
* Revert #3. The reason `getopts.fish` was in its
own file originally is because @bucaran wanted a
standalone, dependency free cli parser solution,
arguably slightly faster than having Awk read
`getopts.awk` for each use. The performance improvement
is negligible at best, but `getopts` is also used
by every single command and future commands and
plugins are very likely to use it as well, so we
so we might as well use the slightly faster version.
2016-01-07 17:44:28 +00:00
Show usage help\.
2016-01-01 21:12:40 +00:00
.
.SH "EXAMPLES"
2016-03-09 09:40:59 +00:00
Install plugins\.
2016-01-01 21:12:40 +00:00
.
2016-03-09 04:24:47 +00:00
.IP "" 4
.
.nf
2016-03-09 09:40:59 +00:00
fisher install fishtape shark get
2016-03-09 04:24:47 +00:00
.
.fi
2016-01-01 21:12:40 +00:00
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.P
2016-03-09 09:40:59 +00:00
Install a plugin from a local directory\.
2016-03-09 04:24:47 +00:00
.
2016-01-01 21:12:40 +00:00
.IP "" 4
.
.nf
2016-03-09 09:40:59 +00:00
fisher install \. /path/to/plugin
2016-01-01 21:12:40 +00:00
.
.fi
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.P
2016-03-09 09:40:59 +00:00
Install a plugin from a URL\.
2016-03-09 04:24:47 +00:00
.
.IP "" 4
.
.nf
2016-03-09 09:40:59 +00:00
fisher install owner/repo
2016-03-09 04:24:47 +00:00
.
.fi
2016-02-07 11:06:04 +00:00
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.P
2016-03-09 09:40:59 +00:00
Install a plugin from a Gist URL\.
2016-03-09 04:24:47 +00:00
.
2016-02-07 11:06:04 +00:00
.IP "" 4
.
.nf
2016-01-01 21:12:40 +00:00
2016-03-09 09:40:59 +00:00
fisher install gist\. github\. com/owner/1f40e1c6e0551b2666b2
2016-02-07 11:06:04 +00:00
.
.fi
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.P
2016-03-09 09:40:59 +00:00
Update Fisherman\.
2016-03-09 04:24:47 +00:00
.
.IP "" 4
.
.nf
2016-03-09 09:40:59 +00:00
fisher update
2016-03-09 04:24:47 +00:00
.
.fi
2016-02-07 11:06:04 +00:00
.
.IP "" 0
2016-01-01 21:12:40 +00:00
.
2016-03-09 04:24:47 +00:00
.P
Update plugins\.
.
2016-01-01 21:12:40 +00:00
.IP "" 4
.
.nf
2016-03-09 04:24:47 +00:00
fisher update shark get
2016-01-01 21:12:40 +00:00
.
.fi
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.P
Uninstall plugins\.
.
.IP "" 4
.
.nf
fisher uninstall fishtape debug
.
.fi
2016-02-29 14:13:29 +00:00
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.P
Uninstall plugins and remove them from the cache\.
.
2016-02-29 14:13:29 +00:00
.IP "" 4
.
.nf
2016-03-09 04:24:47 +00:00
fisher uninstall fishtape debug \- f
2016-02-29 14:13:29 +00:00
.
.fi
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.P
2016-02-29 14:13:29 +00:00
Show all the documentation\.
.
2016-03-09 04:24:47 +00:00
.IP "" 4
.
.nf
fisher help \- \- all
.
.fi
.
2016-02-29 14:13:29 +00:00
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.SH "LIST AND SEARCH"
The list command displays all the plugins you have installed\. The search command queries the index to show what\' s available to install\.
.
.P
List installed plugins\.
.
2016-02-29 14:13:29 +00:00
.IP "" 4
.
.nf
2016-03-09 04:24:47 +00:00
fisher list
debug
* fishtape
> shellder
* spin
@ wipe
2016-02-29 14:13:29 +00:00
.
.fi
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.P
The legend consists of:
2016-02-29 14:13:29 +00:00
.
2016-03-09 04:24:47 +00:00
.P
\fB *\fR The plugin is currently enabled
.
.br
\fB >\fR The plugin is a prompt
.
.br
\fB @\fR The plugin is a symbolic link
.
.br
2016-02-29 14:13:29 +00:00
.
.P
2016-03-09 04:24:47 +00:00
Search the index\.
2016-02-29 14:13:29 +00:00
.
.IP "" 4
.
.nf
2016-03-09 04:24:47 +00:00
fisher search
\. \. \.
* debug Conditional debug logger
errno POSIX error code/string translator
* fishtape TAP producing test runner
flash Flash\- inspired, thunder prompt
fzf Efficient keybindings for fzf
get Press any key to continue
\. \. \.
> shellder Powerline prompt optimized for speed
\. \. \.
.
.fi
.
.IP "" 0
.
.P
Get detailed information about a plugin\.
.
.IP "" 4
.
.nf
fisher search shellder
> shellder by simnalamburt
Powerline prompt optimized for speed
github\. com/simnalamburt/shellder
.
.fi
.
.IP "" 0
.
.P
Search plugins using tags\.
.
.IP "" 4
.
.nf
fisher search \- \- tag={git,test}
\. \. \.
* fishtape TAP producing test runner
git\- branch\- name Get the name of the current Git branch
git\- is\- repo Test if the current directory is a Git repo
git\- is\- dirty Test if there are changes not staged for commit
git\- is\- stashed Test if there are changes in the stash
\. \. \.
2016-02-29 14:13:29 +00:00
.
.fi
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.SH "PLUMBING"
Fisherman commands are pipe aware\. Plumb one with another to create complex functionality\.
.
.P
Update all the plugins in the cache\.
.
.IP "" 4
.
.nf
fisher list | fisher update \-
.
.fi
.
.IP "" 0
2016-02-29 14:13:29 +00:00
.
.P
2016-03-09 04:24:47 +00:00
Enable all the plugins that are currently disabled\.
2016-02-29 14:13:29 +00:00
.
.IP "" 4
.
.nf
2016-03-09 04:24:47 +00:00
fisher list \- \- disabled | fisher install
2016-02-29 14:13:29 +00:00
.
.fi
.
.IP "" 0
.
.P
2016-03-09 04:24:47 +00:00
Uninstall all the plugins and remove them from the cache\.
2016-02-29 14:13:29 +00:00
.
.IP "" 4
.
.nf
2016-03-09 04:24:47 +00:00
fisher list | fisher uninstall \- \- force
2016-02-29 14:13:29 +00:00
.
.fi
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.SH "DOTFILES"
When you install a plugin, Fisherman updates a file known as \fI fishfile\fR to track what plugins are currently enabled\.
.
2016-02-29 14:13:29 +00:00
.P
2016-03-09 04:24:47 +00:00
To customize its location:
.
.IP "" 4
.
.nf
set \- g fisher_file ~/\. dotfiles/fishfile
.
.fi
.
.IP "" 0
.
.SH "FLAT TREE"
Fisherman merges the directory trees of all the plugins it installs into a single flat tree\. Since the flat tree is loaded only once at the start of the shell, Fisherman performs equally well, regardless of the number of plugins installed\.
2016-02-29 14:13:29 +00:00
.
.P
2016-03-09 04:24:47 +00:00
The following illustrates an example Fisherman configuration path with a single plugin and prompt\.
.
.IP "" 4
.
.nf
$fisher_config
|\- \- cache/
|\- \- conf\. d/
| `\- \- my_plugin\. config\. fish
|\- \- fishfile
|\- \- functions/
| |\- \- my_plugin\. fish
| |\- \- fish_prompt\. fish
| `\- \- fish_right_prompt\. fish
|\- \- completions/
| `\- \- my_plugin\. fish
`\- \- man/
`\- \- man1/
`\- \- my_plugin\. 1
.
.fi
2016-02-29 14:13:29 +00:00
.
2016-03-09 04:24:47 +00:00
.IP "" 0
.
.SH "INDEX"
2016-02-29 14:13:29 +00:00
The index is a plain text database that lists Fisherman official plugins\.
.
.P
The index is a list of records, each consisting of the following fields: \fI name\fR , \fI url\fR , \fI info\fR , one or more \fI tags\fR and \fI author\fR \.
.
.P
Fields are separated by a new line \fB \e n\fR \. Tags are separated by one \fI space\fR \.
.
.IP "" 4
.
.nf
z
https://github\. com/fishery/fish\- z
Pure\- fish z directory jumping
z search cd jump
jethrokuan
.
.fi
.
.IP "" 0
.
.P
2016-03-09 04:24:47 +00:00
If you have a plugin to submit to the index, use the \fI submit\fR plugin\.
2016-02-29 14:13:29 +00:00
.
.IP "" 4
.
.nf
fisher install submit
fisher submit my_plugin
.
.fi
.
.IP "" 0
.
.P
Otherwise, submit the plugin manually by creating a pull request in the index repository \fI https://github\. com/fisherman/fisher\- index\fR \.
.
.IP "" 4
.
.nf
git clone https://github\. com/fisherman/fisher\- index
cd index
echo "$name\e n$url\e n$info\e n$tags\e n$author\e n\e n" >> index
git push origin master
.
.fi
.
.IP "" 0
.
2016-03-09 04:24:47 +00:00
.SH "FISHFILE"
2016-02-29 14:13:29 +00:00
Fisherman keeps track of a special file known as \fI fishfile\fR to know what plugins are currently enabled\.
.
.IP "" 4
.
.nf
# My Fishfile
gitio
fishtape
shark
get
shellder
.
.fi
.
.IP "" 0
.
.P
This file is automatically updated as you install and uninstall plugins\.
.
2016-03-09 04:24:47 +00:00
.SH "VARIABLES"
2016-02-29 14:13:29 +00:00
.
.TP
$fisher_home
The home directory\. If you installed Fisherman using the recommended method \fB curl \- sL install\. fisherman\. sh | fish\fR , the location ought to be \fI XDG_DATA_HOME/fisherman\fR \. If you clone Fisherman and run make yourself, the current working directory is used by default\.
.
.TP
$fisher_config
The configuration directory\. This is default location of the \fI fishfile\fR , \fI key_bindings\. fish\fR , \fI cache\fR , \fI functions\fR , \fI completions\fR and \fI conf\. d\fR directories\. The default location is \fI XDG_CONFIG_HOME/fisherman\fR \.
.
.TP
$fisher_file
See FISHFILE above\.
.
.TP
$fisher_cache
The cache directory\. Plugins are downloaded to this location\.
.
.TP
2016-03-09 09:40:59 +00:00
$fisher_alias \fI command\fR =\fI alias\fR \. \. \.
Use this variable to create aliases of Fisherman commands\.
2016-02-29 14:13:29 +00:00
.
2016-03-09 04:24:47 +00:00
.SH "PLUGINS"
Plugins can be utilities, prompts, commands or snippets\.
.
.SS "UTILITIES"
Utilities are plugins that define one or more functions which are mean to be used in the CLI directly by the user\.
.
.P
This example walks you through creating \fI wtc\fR , a plugin based in \fI github/ngerakines/commitment\fR random commit message generator\.
.
.P
Create a directory and initialize a Git repository\.
.
.IP "" 4
.
.nf
mkdir wtc
cd wtc
git init
git remote add origin https://github\. com/<you>/wtc
.
.fi
.
.IP "" 0
.
.P
Add the wtc function\.
.
.IP "" 4
.
.nf
function wtc \- d "Generate a random commit message"
switch "$argv"
case \- h \- \- help
printf "Usage: wtc [\- \- help]\e n\e n"
printf " \- h \- \- help Show usage help\e n"
return
end
curl \- s whatthecommit\. com/index\. txt
end
.
.fi
.
.IP "" 0
.
.P
Install the plugin\.
.
.IP "" 4
.
.nf
fisher install \.
wtc
(\e /)
(O\. o)
(> <) Bunny approves these changes\.
.
.fi
.
.IP "" 0
.
.P
Commit changes and push to your remote origin when you are done\.
.
.IP "" 4
.
.nf
git add \- \- all
git commit \- m "What the commit?"
git push origin master
.
.fi
.
.IP "" 0
.
.P
To submit wtc to the official index\.
.
.IP "" 4
.
.nf
fisher install submit
fisher submit
.
.fi
.
.IP "" 0
.
.P
This will create a PR in the Fisherman index repository\. Once the PR is approved, Fisherman users will be able to install wtc if they have the latest index\.
.
.IP "" 4
.
.nf
fisher install wtc
.
.fi
.
.IP "" 0
.
.P
See \fB fisher help submit\fR for more submit options\.
.
.P
Create a completions directory and add a completions file\.
.
.IP "" 4
.
.nf
mkdir completions
cat > completions/wtc\. fish
complete \- \- command wtc \- \- short h \- \- long help \- \- description "Show usage help"
^
.
.fi
.
.IP "" 0
.
.P
Alternatively, use \fB __fisher_complete\fR to create completions from wtc usage output\.
.
.IP "" 4
.
.nf
wtc \- \- help | __fisher_complete wtc
.
.fi
.
.IP "" 0
.
.P
Create a man/man1 directory and add a man(1) page for wtc\.
.
.P
There are utilities that can help you generate man pages from various text formats\. For example, pandoc(1) and ronn(1)\.
.
.P
To create a man page manually\.
.
.IP "" 4
.
.nf
mkdir \- p man/man1
cat > man/man1/wtc\. 1
\. TH man 1 "Today" "1\. 0" "wtc man page"
\. SH NAME
wtc \e \- Generate a random commit message
\. SH SYNOPSIS
wtc [\- \- help]
\. SH OPTIONS
\- h, \- \- help: Display help information\.
\. SH SEE ALSO
https://github\. com/ngerakines/commitment
^C
.
.fi
.
.IP "" 0
.
.P
A plugin can list dependencies to other plugins using a \fI fishfile\fR \.
.
.P
Create a new file in the root of your project and add the name or URL of your desired dependencies\.
.
.IP "" 4
.
.nf
cat > fishfile
my_plugin
https://github\. com/owner/another_plugin
^D
.
.fi
.
.IP "" 0
.
.SS "PROMPTS"
Prompts, also known as themes, are plugins that modify the appearance of the shell prompt and modify fish syntax colors\.
.
.P
Create a \fB fish_prompt\fR function\.
.
.IP "" 4
.
.nf
function fish_prompt
printf "%s (%s) >> " (prompt_pwd) Fisherman
end
~ (Fisherman) >> type here
.
.fi
.
.IP "" 0
.
.P
To add a right prompt, create a \fB fish_right_prompt\fR function\.
.
.IP "" 4
.
.nf
function fish_right_prompt
printf "%s" (date +%H:%M:%S)
end
.
.fi
.
.IP "" 0
.
.P
Save the functions to a directory and install the prompt as a plugin\.
.
.IP "" 4
.
.nf
mkdir my_prompt
cd my_prompt
functions fish_prompt > fish_prompt\. fish
functions fish_right_prompt > fish_right_prompt\. fish
fisher install \.
.
.fi
.
.IP "" 0
.
.P
Customize the colors fish uses for syntax highlighting\.
.
.IP "" 4
.
.nf
function set_color_custom
set \- U fish_color_normal #\. \. \.
set \- U fish_color_command #\. \. \.
set \- U fish_color_param #\. \. \.
set \- U fish_color_redirection #\. \. \.
set \- U fish_color_comment #\. \. \.
set \- U fish_color_error #\. \. \.
set \- U fish_color_escape #\. \. \.
set \- U fish_color_operator #\. \. \.
set \- U fish_color_end #\. \. \.
set \- U fish_color_quote #\. \. \.
set \- U fish_color_autosuggestion #\. \. \.
set \- U fish_color_valid_path #\. \. \.
set \- U fish_color_cwd #\. \. \.
set \- U fish_color_cwd_root #\. \. \.
set \- U fish_color_match #\. \. \.
set \- U fish_color_search_match #\. \. \.
set \- U fish_color_selection #\. \. \.
set \- U fish_pager_color_prefix #\. \. \.
set \- U fish_pager_color_completion #\. \. \.
set \- U fish_pager_color_description #\. \. \.
set \- U fish_pager_color_progress #\. \. \.
set \- U fish_color_history_current #\. \. \.
end
functions set_color_custom > set_color_custom\. fish
fisher update \.
.
.fi
.
.IP "" 0
.
.SS "COMMANDS"
Commands are plugins that extend the Fisherman CLI adding new \fB fisher <commands>\fR \.
.
.P
Create a function \fB fisher_<command>\fR
.
.IP "" 4
.
.nf
function fisher_time \- d "Say hello"
printf "It\' s %s\e n" (date +%H:%M)
end
.
.fi
.
.IP "" 0
.
.P
Test it works
.
.IP "" 4
.
.nf
fisher time
It\' s 6:30
.
.fi
.
.IP "" 0
.
.P
Make it a plugin
.
.IP "" 4
.
.nf
fisher install fisher_time
.
.fi
.
.IP "" 0
.
.P
This creates a new directory fisher_time in the current working directory and installs the plugin\.
.
.P
The following example implements a command to format plugin information into columns\.
.
.IP "" 4
.
.nf
function fisher_info \- d "Display information about plugins"
switch "$argv"
case \- h \- \- help
printf "Usage: fisher info <name or URL> [\. \. \. ]\e n\e n"
printf " \- h \- \- help Show usage help\e n"
return
end
for item in $argv
fisher search $item \- \- name \- \- info
end | sed \- E \' s/;/: /\' | column
end
fisher install fisher_info
.
.fi
.
.IP "" 0
.
.SS "SNIPPETS"
Snippets are plugins that run code at the start of the shell\. Snippets must be placed inside a sub directory named conf\. d\.
.
.P
The following example implements the fish_postexec hook to display the runtime of the last command in milliseconds\.
.
.IP "" 4
.
.nf
mkdir \- p runtime/conf\. d
cd runtime
cat > conf\. d/fish_postexec\. fish
function fish_postexec \- \- on\- event fish_postexec
printf "%sms\e n" $CMD_DURATION > /dev/stderr
end
^D
fisher install \. /postexec
.
.fi
.
.IP "" 0
.
2016-01-01 21:12:40 +00:00
.SH "AUTHORS"
2016-02-29 14:13:29 +00:00
Fisherman was created by Jorge Bucaran :: @bucaran :: \fI j@bucaran\. me\fR \.
2016-01-01 21:12:40 +00:00
.
.P
2016-02-29 14:13:29 +00:00
See THANKS\. md file for a complete list of contributors\.
2016-01-01 21:12:40 +00:00
.
.SH "SEE ALSO"
2016-02-29 14:13:29 +00:00
fisher help tutorial
2016-01-01 21:12:40 +00:00
.
.br
