2016-01-10 07:01:07 +00:00
fisher-install(1) -- Install Plugins
====================================
2016-01-01 21:12:40 +00:00
## SYNOPSIS
Ahoy! Fisherman 0.5.0
=====================
Add user key bindings support.
Recall $fisher_home/functions are always before user
functions in $fish_function_path. This was an early design
decision in order to prevent users from redefining core
functions by mistake or by means other than using plugins
(recommended). In other words, you are free to create a
plugin that modifies a Fisherman core function, but you
can't redefine a Fisherman function privately by saving it
to your user config fish. If you found a bug in a Fisherman
function, instead of creating a private patch send it
upstream. If you created a function that overrides a
Fisherman core feature, create a plugin. This way the
community can benefit from your code whenever you are ready
to publish it.
By default, Fisherman provides no fish_user_key_bindings,
so if the user has already defined their own
fish_user_key_bindings that one will not be affected.
Now, plugins can define their own key bindings inside a
fish_user_key_bindings.fish or key_bindings.fish at the root
of their repository or inside a functions directory. You can
put your key bindings inside a function or not. If you put
it inside a function, the function name must be the same as
the file without the .fish extension.
$fisher_config/bindings.fish When a plugin with key
bindings is installed for the first time or the only
one with bindings is uninstalled, Fisherman will modify
~/.config/functions/fish_user_key_bindings.fish (or create
it for the first time) and add a single line at the top
of the fish_user_key_bindings function to source the new
$fisher_config/bindings.fish. All the key bindings defined
by the enabled/installed plugins are concatenated and saved
to this file.
This mechanism has the following advantages:
Does not slow down shell start. Does not require Fisherman
to provide his own fish_user_key_bindings by default.
Honors any previously existing user key bindings. Allows
plugin to define their own key bindings and coexist
with the user's key bindings. If the user updates his
fish_user_key_bindings, re-running the function does update
the key bindings. Mega Refactoring
The entire source code of Fisherman received a
major revision and refactoring. The validation and
install/uninstall mechanisms were thoroughly revised and and
broken down into smaller functions easier to test as well as
several other sub parts of the system.
Rewrite fisher search and remove features that are mostly
already covered by fisher --list and remove the ability to
generate information about plugins of unknown origin. The
decision to remove this feature was based in performance
concerns and the result of thinking about the usability
and whether it was really worth the speed tradeoff. The
conclusion is I would rather have better performance and if
I need to query a plugins origin I can always use fisher
--list or fisher --list=url or fisher --list=author.
Add $fisher_update_interval to determine if the index should
update or not when a search query is taking place. The
default value is 10 seconds. This means the index will not
be updated if less than 10 seconds have elapsed since the
last action that triggered an update in the first place. See
Improve Install/Uninstall/Update status output. If a plugin
fails to install decrease the total. If any plugins are
skipped because they are already installed in the case of
fisher install or available in the cache, but disabled in
the case of fisher uninstall they are collected into an
array and displayed in a new section n plugin/s skipped (a,
b, c) at the bottom of the report.
Improve test coverage.
Tightly coupled functions were making testing increasingly
difficult. Most of the test effort was basically testing
whether git clone or git pull. New separation of concerns
makes tests run faster and the difficult install/uninstall
algorithms has better coverage now. Other
Now __fisher_list can list plugins from the cache, a
fishfile/bundle and plugins that are installed/enabled or
disabled. This removes __fisher_file and combines it with
__fisher_list. This also removes fisher -f and replaces it
with fisher -l <file> or fisher --list=<file>.
Rename __fisher_parse_help to __fisher_complete and have the
function create the completions automatically. This allows
you to complete your commands with parseable usage help
faster. The original design was fine, but this change
improves auto-complete performance so it was preferred.
Use __fisher_index_update when building file with Make. This
helps prevent an error when using a fish version < 2.2.0.
See #55 #50 #48.
Add __fisher_index_update to update the index and remove
previously undocumented fisher update --index. This
function is designed to bypass GitHub's server network
cache passing an arbitrary query string to curl like
$fisher_index?RANDOM_NUMBER. This means index updates are
immediately available now.
Add fisher --list=url option to display local plugin url or
path.
Add fisher --list=bare option to display local plugins in
the cache without the * enabled symbol.
Prepend > to the currently enabled theme when using fisher
--list[=cache]. Related #49.
Prepend * to plugin names to indicate they are currently
enabled when using fisher --list[=cache]. See #49.
2016-02-01 19:29:01 +00:00
fisher `install` [*plugins* ...] [`--force`] [`--quiet`] [`--help`]
2016-01-01 21:12:40 +00:00
## USAGE
Ahoy! Fisherman 0.5.0
=====================
Add user key bindings support.
Recall $fisher_home/functions are always before user
functions in $fish_function_path. This was an early design
decision in order to prevent users from redefining core
functions by mistake or by means other than using plugins
(recommended). In other words, you are free to create a
plugin that modifies a Fisherman core function, but you
can't redefine a Fisherman function privately by saving it
to your user config fish. If you found a bug in a Fisherman
function, instead of creating a private patch send it
upstream. If you created a function that overrides a
Fisherman core feature, create a plugin. This way the
community can benefit from your code whenever you are ready
to publish it.
By default, Fisherman provides no fish_user_key_bindings,
so if the user has already defined their own
fish_user_key_bindings that one will not be affected.
Now, plugins can define their own key bindings inside a
fish_user_key_bindings.fish or key_bindings.fish at the root
of their repository or inside a functions directory. You can
put your key bindings inside a function or not. If you put
it inside a function, the function name must be the same as
the file without the .fish extension.
$fisher_config/bindings.fish When a plugin with key
bindings is installed for the first time or the only
one with bindings is uninstalled, Fisherman will modify
~/.config/functions/fish_user_key_bindings.fish (or create
it for the first time) and add a single line at the top
of the fish_user_key_bindings function to source the new
$fisher_config/bindings.fish. All the key bindings defined
by the enabled/installed plugins are concatenated and saved
to this file.
This mechanism has the following advantages:
Does not slow down shell start. Does not require Fisherman
to provide his own fish_user_key_bindings by default.
Honors any previously existing user key bindings. Allows
plugin to define their own key bindings and coexist
with the user's key bindings. If the user updates his
fish_user_key_bindings, re-running the function does update
the key bindings. Mega Refactoring
The entire source code of Fisherman received a
major revision and refactoring. The validation and
install/uninstall mechanisms were thoroughly revised and and
broken down into smaller functions easier to test as well as
several other sub parts of the system.
Rewrite fisher search and remove features that are mostly
already covered by fisher --list and remove the ability to
generate information about plugins of unknown origin. The
decision to remove this feature was based in performance
concerns and the result of thinking about the usability
and whether it was really worth the speed tradeoff. The
conclusion is I would rather have better performance and if
I need to query a plugins origin I can always use fisher
--list or fisher --list=url or fisher --list=author.
Add $fisher_update_interval to determine if the index should
update or not when a search query is taking place. The
default value is 10 seconds. This means the index will not
be updated if less than 10 seconds have elapsed since the
last action that triggered an update in the first place. See
Improve Install/Uninstall/Update status output. If a plugin
fails to install decrease the total. If any plugins are
skipped because they are already installed in the case of
fisher install or available in the cache, but disabled in
the case of fisher uninstall they are collected into an
array and displayed in a new section n plugin/s skipped (a,
b, c) at the bottom of the report.
Improve test coverage.
Tightly coupled functions were making testing increasingly
difficult. Most of the test effort was basically testing
whether git clone or git pull. New separation of concerns
makes tests run faster and the difficult install/uninstall
algorithms has better coverage now. Other
Now __fisher_list can list plugins from the cache, a
fishfile/bundle and plugins that are installed/enabled or
disabled. This removes __fisher_file and combines it with
__fisher_list. This also removes fisher -f and replaces it
with fisher -l <file> or fisher --list=<file>.
Rename __fisher_parse_help to __fisher_complete and have the
function create the completions automatically. This allows
you to complete your commands with parseable usage help
faster. The original design was fine, but this change
improves auto-complete performance so it was preferred.
Use __fisher_index_update when building file with Make. This
helps prevent an error when using a fish version < 2.2.0.
See #55 #50 #48.
Add __fisher_index_update to update the index and remove
previously undocumented fisher update --index. This
function is designed to bypass GitHub's server network
cache passing an arbitrary query string to curl like
$fisher_index?RANDOM_NUMBER. This means index updates are
immediately available now.
Add fisher --list=url option to display local plugin url or
path.
Add fisher --list=bare option to display local plugins in
the cache without the * enabled symbol.
Prepend > to the currently enabled theme when using fisher
--list[=cache]. Related #49.
Prepend * to plugin names to indicate they are currently
enabled when using fisher --list[=cache]. See #49.
2016-02-01 19:29:01 +00:00
fisher `install` *url* ...< br >
fisher `install` *name* ...< br >
fisher `install` *path* ...< br >
fisher `install` *owner/repo* ...< br >
2016-01-01 21:12:40 +00:00
## DESCRIPTION
2016-02-07 11:06:04 +00:00
Install one or more plugins, by name, URL or a local path. If no arguments are given, read the standard input.
2016-01-01 21:12:40 +00:00
2016-01-10 07:01:07 +00:00
In addition, all of the following `owner/repo` variations are accepted:
2016-01-01 21:12:40 +00:00
2016-01-10 07:01:07 +00:00
* owner/repo `>` https://github.com/owner/repo< br >
* *github*/owner/repo `>` https://github.com/owner/repo< br >
* *gh*/owner/repo `>` https://github.com/owner/repo< br >
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
2016-01-10 07:01:07 +00:00
Shortcuts to other common Git repository hosting services are also available:
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
2016-01-10 07:01:07 +00:00
* *bb*/owner/repo `>` https://bitbucket.org/owner/repo< br >
* *gl*/owner/repo `>` https://gitlab.com/owner/repo< br >
* *omf*/owner/repo `>` https://github.com/oh-my-fish/repo< br >
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
2016-02-17 21:42:12 +00:00
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.
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
2016-02-07 11:06:04 +00:00
If the plugin already exists in `$fisher_cache` , the files are only copied to `$fisher_config` . To update a plugin use `fisher update` .
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
2016-01-10 07:01:07 +00:00
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. See *Plugins* in `fisher help fishfile` .
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
2016-02-07 11:06:04 +00:00
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.
2016-01-01 21:12:40 +00:00
## OPTIONS
Ahoy! Fisherman 0.5.0
=====================
Add user key bindings support.
Recall $fisher_home/functions are always before user
functions in $fish_function_path. This was an early design
decision in order to prevent users from redefining core
functions by mistake or by means other than using plugins
(recommended). In other words, you are free to create a
plugin that modifies a Fisherman core function, but you
can't redefine a Fisherman function privately by saving it
to your user config fish. If you found a bug in a Fisherman
function, instead of creating a private patch send it
upstream. If you created a function that overrides a
Fisherman core feature, create a plugin. This way the
community can benefit from your code whenever you are ready
to publish it.
By default, Fisherman provides no fish_user_key_bindings,
so if the user has already defined their own
fish_user_key_bindings that one will not be affected.
Now, plugins can define their own key bindings inside a
fish_user_key_bindings.fish or key_bindings.fish at the root
of their repository or inside a functions directory. You can
put your key bindings inside a function or not. If you put
it inside a function, the function name must be the same as
the file without the .fish extension.
$fisher_config/bindings.fish When a plugin with key
bindings is installed for the first time or the only
one with bindings is uninstalled, Fisherman will modify
~/.config/functions/fish_user_key_bindings.fish (or create
it for the first time) and add a single line at the top
of the fish_user_key_bindings function to source the new
$fisher_config/bindings.fish. All the key bindings defined
by the enabled/installed plugins are concatenated and saved
to this file.
This mechanism has the following advantages:
Does not slow down shell start. Does not require Fisherman
to provide his own fish_user_key_bindings by default.
Honors any previously existing user key bindings. Allows
plugin to define their own key bindings and coexist
with the user's key bindings. If the user updates his
fish_user_key_bindings, re-running the function does update
the key bindings. Mega Refactoring
The entire source code of Fisherman received a
major revision and refactoring. The validation and
install/uninstall mechanisms were thoroughly revised and and
broken down into smaller functions easier to test as well as
several other sub parts of the system.
Rewrite fisher search and remove features that are mostly
already covered by fisher --list and remove the ability to
generate information about plugins of unknown origin. The
decision to remove this feature was based in performance
concerns and the result of thinking about the usability
and whether it was really worth the speed tradeoff. The
conclusion is I would rather have better performance and if
I need to query a plugins origin I can always use fisher
--list or fisher --list=url or fisher --list=author.
Add $fisher_update_interval to determine if the index should
update or not when a search query is taking place. The
default value is 10 seconds. This means the index will not
be updated if less than 10 seconds have elapsed since the
last action that triggered an update in the first place. See
Improve Install/Uninstall/Update status output. If a plugin
fails to install decrease the total. If any plugins are
skipped because they are already installed in the case of
fisher install or available in the cache, but disabled in
the case of fisher uninstall they are collected into an
array and displayed in a new section n plugin/s skipped (a,
b, c) at the bottom of the report.
Improve test coverage.
Tightly coupled functions were making testing increasingly
difficult. Most of the test effort was basically testing
whether git clone or git pull. New separation of concerns
makes tests run faster and the difficult install/uninstall
algorithms has better coverage now. Other
Now __fisher_list can list plugins from the cache, a
fishfile/bundle and plugins that are installed/enabled or
disabled. This removes __fisher_file and combines it with
__fisher_list. This also removes fisher -f and replaces it
with fisher -l <file> or fisher --list=<file>.
Rename __fisher_parse_help to __fisher_complete and have the
function create the completions automatically. This allows
you to complete your commands with parseable usage help
faster. The original design was fine, but this change
improves auto-complete performance so it was preferred.
Use __fisher_index_update when building file with Make. This
helps prevent an error when using a fish version < 2.2.0.
See #55 #50 #48.
Add __fisher_index_update to update the index and remove
previously undocumented fisher update --index. This
function is designed to bypass GitHub's server network
cache passing an arbitrary query string to curl like
$fisher_index?RANDOM_NUMBER. This means index updates are
immediately available now.
Add fisher --list=url option to display local plugin url or
path.
Add fisher --list=bare option to display local plugins in
the cache without the * enabled symbol.
Prepend > to the currently enabled theme when using fisher
--list[=cache]. Related #49.
Prepend * to plugin names to indicate they are currently
enabled when using fisher --list[=cache]. See #49.
2016-02-01 19:29:01 +00:00
* `-f` `--force` :
Reinstall given plugin/s. If the plugin is already in the cache, it will be installed from the cache.
2016-01-01 21:12:40 +00:00
* `-q` `--quiet` :
Enable quiet mode.
* `-h` `--help` :
Show usage help.
2016-01-10 07:01:07 +00:00
## EXAMPLES
2016-02-07 11:06:04 +00:00
Here is the directory tree of *my_plugin* :
2016-01-10 07:01:07 +00:00
```
my_plugin
|-- README.md
|-- my_plugin.fish
|-- functions
2016-02-27 02:08:32 +00:00
| `-- my_plugin_helper.fish
2016-01-10 07:01:07 +00:00
|-- completions
2016-02-27 02:08:32 +00:00
| `-- my_plugin.fish
2016-01-10 07:01:07 +00:00
|-- test
2016-02-27 02:08:32 +00:00
| `-- my_plugin.fish
`-- man
`-- man1
`-- my_plugin.1
2016-01-10 07:01:07 +00:00
```
And here is the directory tree of `$fisher_config/` after running `fisher install my_plugin` :
```
$fisher_config
|-- functions
2016-02-27 02:08:32 +00:00
| |-- my_plugin.fish
| `-- my_plugin_helper.fish
2016-01-10 07:01:07 +00:00
|-- completions
2016-02-27 02:08:32 +00:00
| `-- my_plugin.fish
2016-01-10 07:01:07 +00:00
|-- man
2016-02-27 02:08:32 +00:00
| `-- man1
| `-- my_plugin.1
`-- cache
2016-01-10 07:01:07 +00:00
|-- my_other_plugin
2016-02-27 02:08:32 +00:00
`-- my_plugin/...
2016-01-10 07:01:07 +00:00
```
2016-02-07 11:06:04 +00:00
In addition, any `init.fish` and `*.config.fish` files, are copied to `$fisher_config/conf.d` and evaluated during the start of the shell.
To prevent name collisions, `init.fish` files are renamed to `my_plugin.init.fish` .
2016-01-10 07:01:07 +00:00
2016-02-07 11:06:04 +00:00
## EXAMPLES
* Install plugins from multiple sources.
2016-02-27 02:08:32 +00:00
```fish
2016-02-07 11:06:04 +00:00
fisher install fishtape simnalamburt/shellder ~/plugins/my_plugin
```
2016-01-01 21:12:40 +00:00
## SEE ALSO
2016-02-27 02:08:32 +00:00
`fisher` (1)< br >
`fisher help config` < br >
`fisher help update` < br >
`fisher help uninstall` < br >
