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
127 lines
3.9 KiB
Markdown
127 lines
3.9 KiB
Markdown
fisher-search(1) -- Search Plugin Index
|
|
==========================================
|
|
|
|
## SYNOPSIS
|
|
|
|
fisher `search` [*plugins* ...]<br>
|
|
fisher `search` [`--select`=*all*|*cache*|*remote*]<br>
|
|
fisher `search` [`--field`=*name*|*url*|*info*|*tag*|*author*]<br>
|
|
fisher `search` [`--`*field[*=*match*]] <br>
|
|
fisher `search` [`--`*field*~`/`*regex*`/`] <br>
|
|
fisher `search` [`--query`=*field*[`&&`,`||`]*field*...]<br>
|
|
fisher `search` [`--and`] [`--or`] [`--quiet`] [`--help`]<br>
|
|
|
|
## USAGE
|
|
|
|
fisher `search` *plugin*<br>
|
|
fisher `search` *owner/repo*<br>
|
|
|
|
## DESCRIPTION
|
|
|
|
Search the Fisherman index database. You can use a custom index file by setting `$fisher_index` to your preferred URL or file. See `fisher help config` and *Index* in `fisher help tour`.
|
|
|
|
A copy of the index is downloaded every time a search query happens, keeping the index up to date all the time.
|
|
|
|
The index file consists of records separated by blank lines `'\n\n'` and each record consists of fields separated by a single line `'\n'`.
|
|
|
|
For example:
|
|
|
|
```
|
|
name
|
|
url
|
|
info
|
|
tag1 tag2 tag3 ...
|
|
author
|
|
```
|
|
|
|
See *Output* for more information.
|
|
|
|
## OPTIONS
|
|
|
|
* `-s --select[=all|cache|remote]`:
|
|
Select the record source. --select=*cache* queries only local plugins, i.e., those inside `$fisher_cache`. --select=*remote* queries all plugins not in the cache, i.e, those available to install. --select=*all* queries everything.
|
|
|
|
* `-f --field=name|url|info|tag|author`:
|
|
Display only the given fields from the selected records. Use --*field* as a shortcut for --field=*field*. For example `fisher search --url` will display only the URLs for
|
|
|
|
* `--field[=match]`:
|
|
Filter the result set by *field*=*match*, where *field* can be one or more of `name`, `url`, `info`, `tag` or `author`. If *match* is not given, this is equivalent to --select=*field*. Use `!=` to negate the query.
|
|
|
|
* `--field[~/regex/]`:
|
|
Essentially the same as --*field*=*match*, but with Regular Expression support. --*field*~/*regex*/ filters the result set using the given /*regex*/. For example, --name=/^*match*$/ is the same as --*field*=*match* and --url~/oh-my-fish/ selects only oh-my-fish plugins. Use `!~` to negate the query.
|
|
|
|
* `-a --and`:
|
|
Join query with the logical AND operator.
|
|
|
|
* `-o --or`:
|
|
Join query with the logical OR operator. This the default operator for each query.
|
|
|
|
* `-Q --query=field[&&,||]field...`:
|
|
Use a custom search expression. For example, `--query=name~/[0-9]/||name~/^[xyz]/` selects all plugins that contain numbers in their name *or* begin with the characters *x*, *y* or *z*.
|
|
|
|
* `-q --quiet`:
|
|
Enable quiet mode.
|
|
|
|
* `-h --search`:
|
|
Show help.
|
|
|
|
## OUTPUT
|
|
|
|
The default behavior is to print the result set to standard output in their original format.
|
|
|
|
```
|
|
fisher search shark
|
|
shark
|
|
https://github.com/bucaran/shark
|
|
Sparkline Generator
|
|
chart tool
|
|
bucaran
|
|
```
|
|
|
|
Search is optimized for parsing when using the filters: `--name`, `--url`, `--info`, `--tags`, `--author` or `--field=name|url|info|tag|author`.
|
|
|
|
```
|
|
fisher search shark --name --url
|
|
|
|
shark;https://github.com/bucaran/shark
|
|
```
|
|
|
|
The result set above consists of single line `'\n'` separated records, and each record consists of one or more of the given fields separated by a semicolon `';'`.
|
|
|
|
## EXAMPLES
|
|
|
|
* Display all plugins by name and format into multiple columns.
|
|
|
|
```
|
|
fisher search --name | column
|
|
```
|
|
|
|
* Display all plugins by URL, sans *https://github.com/* and format into multiple columns.
|
|
|
|
```
|
|
fisher search --field=url --select=all | sed 's|https://github.com/||' | column
|
|
```
|
|
|
|
* Display all remote plugins by name tagged as *a* or *b*.
|
|
|
|
```
|
|
fisher search --select=remote --name --tag=github --or --tag=tool
|
|
```
|
|
|
|
* Search plugins from a list of one or more urls and / or names and display their authors.
|
|
|
|
```
|
|
fisher search $urls $names --url
|
|
```
|
|
|
|
* Search all plugins in the cache whose name does not start with the letter `s`.
|
|
|
|
```
|
|
fisher search --select=cache --name~/^[^s]/
|
|
```
|
|
|
|
## SEE ALSO
|
|
|
|
fisher(1)<br>
|
|
fisher help plugins<br>
|