2016-02-24 06:43:25 +00:00
[![Build Status][travis-badge]][travis-link]
[![Fisherman Version][version-badge]][version-link]
[![Slack Room][slack-badge]][slack-link]
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
< a name = "fisherman" > < / a >
2016-02-24 11:40:54 +00:00
< h1 align = "center" >
2016-02-09 23:21:57 +00:00
< br >
2016-02-24 11:40:54 +00:00
< a href = "http://fisherman.sh" > < img
2016-02-24 08:12:19 +00:00
alt="Fisherman"
2016-02-25 12:50:21 +00:00
width=700px
2016-02-24 11:40:54 +00:00
src="https://rawgit.com/fisherman/logo/master/fisherman-black-white.svg">< / a >
2016-02-09 23:21:57 +00:00
< br >
< br >
2016-02-24 11:40:54 +00:00
< / h1 >
2016-02-03 00:59:59 +00:00
2016-04-07 11:08:38 +00:00
**[Fisherman]** is a blazing fast, parallel plugin manager for [fish].
2016-01-01 21:12:40 +00:00
2016-03-09 04:24:47 +00:00
```fish
curl -sL get.fisherman.sh | fish
```
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
2016-03-09 04:24:47 +00:00
[![play]][play-link]
2016-03-02 10:55:03 +00:00
2016-03-13 19:20:40 +00:00
< sub > Install instructions for fish can be found < a href = "https://github.com/fisherman/fisherman/wiki/Installing-Fish" > here< / a > .< / sub >
2016-03-09 04:24:47 +00:00
2016-04-06 05:33:37 +00:00
< sub > 现在提供中文支持,若有疑问,可以中文提交ISSUE,我们会尽快解决,感谢您的支持< / sub >
2016-03-10 05:08:48 +00:00
## Install
2016-03-09 04:24:47 +00:00
2016-03-02 10:55:03 +00:00
```fish
curl -sL get.fisherman.sh | fish
```
2016-04-07 11:08:38 +00:00
< sub > See [other] install options.< / sub >
2016-03-09 04:24:47 +00:00
## CLI
2016-03-10 05:08:48 +00:00
The Fisherman CLI consists of: *install* , *update* , *uninstall* , *list* , *search* and *help* and the following aliases: *i* for install, *u* for update, *l* for list, *s* for search and *h* for help.
2016-03-09 04:24:47 +00:00
### Examples
* Install plugins.
2016-03-10 05:08:48 +00:00
```
2016-03-13 19:20:40 +00:00
fisher i fishtape shark get bobthefish
```
* Install Oh My Fish! plugins.
```fish
fisher i omf/plugin-{percol,jump,fasd}
2016-03-09 04:24:47 +00:00
```
* Install a plugin from a local directory.
```fish
2016-03-13 19:20:40 +00:00
fisher i ./path/to/plugin
2016-03-09 04:24:47 +00:00
```
2016-03-13 19:20:40 +00:00
* Install a plugin from various URLs.
2016-03-09 04:24:47 +00:00
```fish
2016-03-13 19:20:40 +00:00
fisher i https://github.com/some/plugin another/plugin bb:one/more
2016-03-09 04:24:47 +00:00
```
2016-03-13 19:20:40 +00:00
* Install a plugin from a Gist.
2016-03-09 04:24:47 +00:00
```fish
2016-03-13 19:20:40 +00:00
fisher i gist.github.com/owner/1f40e1c6e0551b2666b2
2016-03-09 04:24:47 +00:00
```
2016-03-13 19:20:40 +00:00
* Update everything.
2016-03-09 09:40:59 +00:00
2016-03-10 05:08:48 +00:00
```
2016-03-13 19:20:40 +00:00
fisher u
2016-03-09 09:40:59 +00:00
```
2016-03-09 04:24:47 +00:00
* Update plugins.
2016-03-10 05:08:48 +00:00
```
2016-03-13 19:20:40 +00:00
fisher u shark get
2016-03-09 04:24:47 +00:00
```
* Uninstall plugins.
2016-03-10 05:08:48 +00:00
```
2016-03-09 04:24:47 +00:00
fisher uninstall fishtape debug
```
2016-03-13 19:20:40 +00:00
* Get help.
2016-03-09 04:24:47 +00:00
```fish
2016-03-13 19:20:40 +00:00
fisher h
2016-03-09 04:24:47 +00:00
```
## 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.
2016-03-10 05:08:48 +00:00
List installed plugins.
2016-03-09 04:24:47 +00:00
```
fisher list
debug
2016-04-08 09:00:06 +00:00
fishtape
spin
2016-03-30 17:42:44 +00:00
> superman
2016-03-09 04:24:47 +00:00
@ wipe
```
2016-03-10 05:08:48 +00:00
Search the index.
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
...
2016-03-30 17:42:44 +00:00
> superman Powerline prompt based on Superman
2016-03-09 04:24:47 +00:00
...
```
2016-03-13 19:20:40 +00:00
Query the index using regular expressions.
2016-03-09 04:24:47 +00:00
```
2016-03-13 19:20:40 +00:00
fisher search --name~/git-is/
git-is-dirty Test if there are changes not staged for commit
git-is-empty Test if a repository is empty
git-is-repo Test if the current directory is a Git repo
git-is-staged Test if there are changes staged for commit
git-is-stashed Test if there are changes in the stash
git-is-touched Test if there are changes in the working tree
2016-03-09 04:24:47 +00:00
```
2016-03-13 19:20:40 +00:00
Search using tags.
2016-03-09 04:24:47 +00:00
```
fisher search --tag={git,test}
...
2016-03-13 19:20:40 +00:00
* fishtape TAP producing test runner
2016-03-09 04:24:47 +00:00
git-branch-name Get the name of the current Git branch
git-is-dirty Test if there are changes not staged for commit
2016-03-13 19:20:40 +00:00
git-is-empty Test if a repository is empty
git-is-repo Test if the current directory is a Git repo
git-is-staged Test if there are changes staged for commit
2016-03-09 04:24:47 +00:00
git-is-stashed Test if there are changes in the stash
2016-03-13 19:20:40 +00:00
git-is-touched Test if there are changes in the working tree
2016-03-09 04:24:47 +00:00
...
```
2016-03-10 05:08:48 +00:00
The legend consists of:
* `>` The plugin is a prompt
2016-04-08 09:00:06 +00:00
* `*` The plugin is installed
2016-03-10 05:08:48 +00:00
* `@` The plugin is a symbolic link
2016-03-09 04:24:47 +00:00
## Plumbing
Fisherman commands are pipe aware. Plumb one with another to create complex functionality.
2016-03-13 19:20:40 +00:00
Update plugins installed as symbolic links.
2016-03-09 04:24:47 +00:00
```fish
2016-03-13 19:20:40 +00:00
fisher list --link | fisher update -
2016-03-09 04:24:47 +00:00
```
2016-03-13 19:20:40 +00:00
Enable all the plugins currently disabled.
2016-03-09 04:24:47 +00:00
```fish
fisher list --disabled | fisher install
```
2016-03-13 19:20:40 +00:00
Uninstall all the plugins and remove them from the cache.
2016-03-09 04:24:47 +00:00
```fish
fisher list | fisher uninstall --force
```
## Dotfiles
2016-03-13 19:20:40 +00:00
When you install a plugin, Fisherman updates the *fishfile* to track what plugins are currently enabled.
2016-03-09 04:24:47 +00:00
* Customize the location of the fishfile.
```fish
set -g fisher_file ~/.dotfiles/fishfile
```
## 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.
The following illustrates an example Fisherman configuration path with a single plugin and prompt.
```
$fisher_config
2016-03-10 05:08:48 +00:00
├── cache
├── completions
│ └── my_plugin.fish
├── conf.d
│ └── my_plugin.fish
├── fishfile
├── functions
│ ├── fish_prompt.fish
│ ├── fish_right_prompt.fish
│ └── my_plugin.fish
└── man
└── man1
└── my_plugin.1
2016-03-09 04:24:47 +00:00
```
## Index
The index is a plain text database that lists Fisherman official plugins.
2016-03-13 19:20:40 +00:00
The index lists records, each consisting the fields: *name* , *url* , *info* , one or more *tags* and *author* .
2016-03-09 04:24:47 +00:00
```
z
https://github.com/fishery/fish-z
Pure-fish z directory jumping
z search cd jump
jethrokuan
```
If you have a plugin you would like to submit to the index, use the submit plugin.
```
fisher install submit
2016-03-13 19:20:40 +00:00
fisher submit my_plugin description tags url
2016-03-09 04:24:47 +00:00
```
2016-03-13 19:20:40 +00:00
Or, submit the plugin manually by creating a pull request in the [index ](https://github.com/fisherman/fisher-index ) repository.
2016-03-09 04:24:47 +00:00
```
git clone https://github.com/fisherman/fisher-index
cd index
echo "$name\n$url\n$info\n$tags\n$author\n\n" >> index
git push origin master
```
## Variables
2016-03-13 19:20:40 +00:00
* $fisher_home:
The home directory. If you installed Fisherman using the recommended method, the location ought to be *XDG_DATA_HOME/fisherman* .
2016-03-09 04:24:47 +00:00
2016-03-13 19:20:40 +00:00
* $fisher_config:
The configuration directory. This is default location of your *fishfile* , *key_bindings.fish* , *cache* , *functions* , *completions* and *conf.d* directories. *XDG_CONFIG_HOME/fisherman* by default.
2016-03-09 04:24:47 +00:00
2016-03-13 19:20:40 +00:00
* $fisher_file:
See [fishfile ](#fishfile ) above.
2016-03-09 04:24:47 +00:00
2016-03-13 19:20:40 +00:00
* $fisher_cache:
2016-03-09 04:24:47 +00:00
The cache directory. Plugins are downloaded to this location.
2016-03-13 19:20:40 +00:00
* $fisher_alias *command* =*alias* ...:
2016-03-09 09:40:59 +00:00
Use this variable to create aliases of Fisherman commands.
2016-03-09 04:24:47 +00:00
2016-02-13 11:37:49 +00:00
[travis-link]: https://travis-ci.org/fisherman/fisherman
[travis-badge]: https://img.shields.io/travis/fisherman/fisherman.svg?style=flat-square
2016-02-24 11:35:45 +00:00
2016-03-30 17:45:22 +00:00
[version-badge]: https://img.shields.io/badge/latest-v1.4.0-00B9FF.svg?style=flat-square
2016-02-13 11:37:49 +00:00
[version-link]: https://github.com/fisherman/fisherman/releases
2016-02-24 11:35:45 +00:00
2016-02-13 11:37:49 +00:00
[slack-link]: https://fisherman-wharf.herokuapp.com/
[slack-badge]: https://img.shields.io/badge/slack-join%20the%20chat-00B9FF.svg?style=flat-square
2016-02-05 06:31:12 +00:00
2016-03-02 10:55:03 +00:00
[play]: https://cloud.githubusercontent.com/assets/8317250/13458315/dfcac4b4-e0af-11e5-8ee5-df31d1cdf409.png
[play-link]: http://fisherman.sh/#demo
2016-02-24 08:54:00 +00:00
2016-02-27 09:51:25 +00:00
[Get Started]: https://github.com/fisherman/fisherman/wiki
2016-02-24 08:28:22 +00:00
[Plugins]: http://fisherman.sh/#search
2016-02-24 08:54:00 +00:00
[fish]: https://github.com/fish-shell/fish-shell
2016-03-09 04:24:47 +00:00
[other]: https://github.com/fisherman/fisherman/wiki/Installing-Fisherman#notes
[Fisherman]: http://fisherman.sh
2016-03-13 19:20:40 +00:00
[new]: https://github.com/fishery/new
