mirror of
https://github.com/jorgebucaran/fisher
synced 2024-11-09 07:10:27 +00:00
eae01edf51
www.fisherman.sh Still a WIP. Powered by Jekyll and hosted by GitHub pages. * Refactor fisher install / fisher uninstall by extracting the logic to enable / disable plugins into __fisher_plugin. The algorithm to enable/disable plugins is essentially the same. The only difference is enable, copies/symlinks files and disable removes them from $fisher_config/.... Closes #45. * Add support for legacy oh-my-fish! plugins using .load initialization files. Closes #35. * Add support for Tackle Fish framework initialization modules. Closes #35. * Add support for plugins that share scripts in languages like Python or Perl. For example oh-my-fish/plugin-vi-mode assumes there is a vi-mode-impl.py file in the same path of the running script. This opens the door for including code snippets in other languages. * Any files inside a share directory, except for *.md or *.fish files, are copied to $fisher_config/functions. This allows you to run legacy plugins that retrieve the currently running script path with (dirname (status -f)) out of the box. * A cleaner alternative is using the new $fisher_share variable like this: python $fisher_share/my_plugin_script.py. * $fisher_share points to $fisher_config/share by default, but you may change this in your user config.fish. This path contains copies (or symbolic links) to the same script files copied to $fisher_config/functions. * Introduce the $fisher_share_extensions variable to let you customize what extensions Fisherman is aware of. Only extensions in this array will be processed during the install process. The default is py rb php pl awk sed. * .fish and .md extensions are always ignored. * Remove ad-hoc debug d function created by mistake in the Fisherman config.fish file. Closes #34. * Remove almost useless fisher --alias. You can still create aliases using $fisher_alias. It's difficult to add auto-complete to this feature, and even if we do so, it is slow. * Fix bug introduced in the previous release caused by swapping the lines that calculate the index of the current plugin being installed/updated/uninstalled and the line that displays the value, causing the CLI to show incorrect values. Closes #36. Thanks @kballard * Add cache, enabled and disabled options to fisher --list. Now you can type fisher -l enabled to get a list of what plugins are currently enabled. * Add new $fisher_plugins universal variable to keep track of what plugins are enabled / disabled. * Update completions after a plugin is installed, updated or uninstalled. * Improve autocomplete speed by removing the descriptions from plugins installed with custom URLs. * fisher --list displays nothing and returns 1 when there are no plugins installed. Closes #38. * fisher uninstall does not attempt to uninstall plugins already disabled by looking at the $fisher_plugins array. --force will bypass this. Closes #40
66 lines
2.0 KiB
Markdown
66 lines
2.0 KiB
Markdown
fisher(1) -- Fish Plugin Manager
|
|
================================
|
|
|
|
## SYNOPSIS
|
|
|
|
`fisher` *command* [*options*] [`--version`] [`--help`]<br>
|
|
`fisher` `--list=cache|enabled|disabled`<br>
|
|
`fisher` `--file`=*fishfile*<br>
|
|
|
|
## DESCRIPTION
|
|
|
|
Fisherman is a plugin manager and CLI toolkit for `fish(1)` to help you build powerful utilities and share your code easily.
|
|
|
|
The following commands are available out of the box: *install*, *uninstall*, *update*, *search* and *help*. See `fisher help <command>` for information about each command.
|
|
|
|
## OPTIONS
|
|
|
|
* `--list=cache|enabled|disabled`:
|
|
List plugins according to the given category.
|
|
|
|
* `-f --file=fishfile`:
|
|
Read *fishfile* and display its contents. If *fishfile* is null or an empty string, your user *fishfile* in `$fisher_config/fishfile` will be shown instead. Use a dash `-` to read from the standard input. Other formats such as the oh-my-fish bundle files are supported as well.
|
|
|
|
* `-v --version`:
|
|
Show version information. Fisherman's current version can be found in the VERSION file at the root of the project. The version scheme is based in `Semantic Versioning` and uses Git annotated tags to track releases.
|
|
|
|
* `-h --help`:
|
|
Show usage help.
|
|
|
|
## CUSTOM COMMANDS
|
|
|
|
A Fisherman command is a function that you invoke using the `fisher` CLI utility. By convention, any function like `fisher_<my_command>` is recognized as a Fisherman command. You can create plugins that add new commands this way. See `fisher help commands` and `fisher help plugins` for more information.
|
|
|
|
## EXAMPLES
|
|
|
|
* Install plugins.
|
|
|
|
```
|
|
fisher install fishtape shark
|
|
```
|
|
|
|
* Install plugins from a *fishfile* or bundle:
|
|
|
|
```
|
|
fisher --file=path/to/bundle | fisher install
|
|
```
|
|
|
|
## AUTHORS
|
|
|
|
Fisherman was created by Jorge Bucaran *j@bucaran.me*.
|
|
|
|
See AUTHORS file for the complete list of contributors.
|
|
|
|
## SEE ALSO
|
|
|
|
fisher help tour<br>
|
|
fisher help help<br>
|
|
fisher help update<br>
|
|
fisher help search<br>
|
|
fisher help config<br>
|
|
fisher help install<br>
|
|
fisher help plugins<br>
|
|
fisher help commands<br>
|
|
fisher help fishfile<br>
|
|
fisher help uninstall<br>
|