mirror of
https://github.com/jorgebucaran/fisher
synced 2024-07-02 23:11:48 +02:00
aed81667c9
* 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. * ☝️ 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.
255 lines
5.4 KiB
Groff
255 lines
5.4 KiB
Groff
.\" generated with Ronn/v0.7.3
|
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
.
|
|
.TH "FISHER\-SEARCH" "1" "January 2016" "" "fisherman"
|
|
.
|
|
.SH "NAME"
|
|
\fBfisher\-search\fR \- Search Fisherman Index
|
|
.
|
|
.SH "SYNOPSIS"
|
|
fisher \fBsearch\fR [\fIname\fR or \fIurl\fR]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-select\fR=\fIall\fR|\fIcache\fR|\fIremote\fR]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-field\fR=\fIname\fR|\fIurl\fR|\fIinfo\fR|\fItag\fR|\fIauthor\fR]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-\fR\fIfield\fR=\fImatch\fR]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-\fR\fIfield\fR~\fB/\fR\fIregex\fR\fB/\fR]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-query\fR=\fIfield\fR[\fB&&\fR,\fB||\fR]\fIfield\fR\.\.\.]
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR [\fB\-\-and\fR] [\fB\-\-or\fR] [\fB\-\-quiet\fR] [\fB\-\-help\fR]
|
|
.
|
|
.br
|
|
.
|
|
.SH "USAGE"
|
|
fisher \fBsearch\fR \fIplugin\fR
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR \fIowner/repo\fR
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR \-\-field=\fIname\fR \-\-select=all | column
|
|
.
|
|
.br
|
|
fisher \fBsearch\fR \-\-tag=tag1 \-\-and \-\-tag=tag2
|
|
.
|
|
.SH "DESCRIPTION"
|
|
Search the Fisherman index database\. You can use a custom index file by setting \fB$fisher_index\fR to your preferred url or file\. See \fBfisher help config\fR and \fBfisher\fR(7)#{\fBIndex\fR}\.
|
|
.
|
|
.P
|
|
A copy of the index is downloaded each time a search query happens, keeping the index up to date all the time\.
|
|
.
|
|
.P
|
|
The index file consists of records separated by blank lines \fB\'\en\en\'\fR and each record consists of fields separated by a single line \fB\'\en\'\fR\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
name
|
|
url
|
|
info | description
|
|
tag1 tag2 \.\.\.
|
|
author
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
See #{\fBOutput\fR} for more information\.
|
|
.
|
|
.SH "OPTIONS"
|
|
.
|
|
.TP
|
|
\fB\-s\fR \fB\-\-select\fR[=\fIall\fR|\fIcache\fR|\fIremote\fR]
|
|
Select the record source\. \-\-select=\fIcache\fR queries only local plugins, i\.e\., those inside \fB$fisher_cache\fR\. \-\-select=\fIremote\fR queries all plugins not in the cache, i\.e, those available to install\. \-\-select=\fIall\fR queries everything\.
|
|
.
|
|
.TP
|
|
\fB\-f\fR \fB\-\-field\fR=\fIname\fR|\fIurl\fR|\fIinfo\fR|\fItag\fR|\fIauthor\fR
|
|
Display only the given fields from the selected records\. Use \-\-\fIfield\fR instead as a shortcut for \fB\-\-field\fR=name\.
|
|
.
|
|
.TP
|
|
\-\-\fIfield\fR[=\fImatch\fR]
|
|
Filter the result set by \fIfield\fR=\fImatch\fR, where \fIfield\fR can be one or more of \fBname\fR, \fBurl\fR, \fBinfo\fR, \fBtag\fR or \fBauthor\fR\. If \fImatch\fR is not given, this is equivalent to \fB\-\-select\fR=\fIfield\fR\. Use \fB!=\fR to negate the query\.
|
|
.
|
|
.TP
|
|
\-\-\fIfield\fR[~\fB/\fR\fIregex\fR\fB/\fR]
|
|
Essentially the same as \-\-\fIfield\fR=\fImatch\fR, but with Regular Expression support\. \-\-\fIfield\fR~\fB/\fR\fIregex\fR\fB/\fR filters the result set using the given \fB/\fR\fIregex\fR\fB/\fR\. For example, \-\-name=\fB/\fR^\fImatch\fR$\fB/\fR is the same as \-\-\fIfield\fR=\fImatch\fR and \-\-url~\fB/\fRoh\-my\-fish\fB/\fR selects only oh-my-fish plugins\. Use \fB!~\fR to negate the query\.
|
|
.
|
|
.TP
|
|
\fB\-a\fR \fB\-\-and\fR
|
|
Join query with a logical AND operator\.
|
|
.
|
|
.TP
|
|
\fB\-o\fR \fB\-\-or\fR
|
|
Join query with a logical OR operator\. This the default operator for each query operation\.
|
|
.
|
|
.TP
|
|
\fB\-Q\fR \fB\-\-query\fR=\fIfield\fR[\fB&&\fR,\fB||\fR]\fIfield\fR\.\.\.
|
|
Use a custom search expression\. For example, \-\-query=\'name~\fB/\fR[0\-9]\fB/\fR||name~\fB/\fR^[xyz]\fB/\fR\' selects all plugins that contain numbers in their name \fIor\fR begin with the characters \fIx\fR, \fIy\fR or \fIz\fR\.
|
|
.
|
|
.TP
|
|
\fB\-q\fR \fB\-\-quiet\fR
|
|
Enable quiet mode\.
|
|
.
|
|
.TP
|
|
\fB\-h\fR \fB\-\-search\fR
|
|
Show usage search\.
|
|
.
|
|
.SH "OUTPUT"
|
|
The default behavior is to print the result set to standard output in its original format\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search shark
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
\fB\.\.\.\fR
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
shark
|
|
https://github\.com/bucaran/shark
|
|
Sparklines for your Fish
|
|
chart tool
|
|
bucaran
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
Search is optimized for parsing when using filters: \fB\-\-name\fR, \fB\-\-url\fR, \fB\-\-info\fR, \fB\-\-tags\fR, \fB\-\-author\fR or \fB\-\-field\fR=\fIname\fR|\fIurl\fR|\fIinfo\fR|\fItag\fR|\fIauthor\fR\.
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search shark \-\-name \-\-url
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
\fB\.\.\.\fR
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
shark;https://github\.com/bucaran/shark
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.P
|
|
The result set above consists of single line \fB\'\en\'\fR separated records where each record consists of one or more of the given fields separated by a semicolon \fB\';\'\fR\.
|
|
.
|
|
.SH "EXAMPLES"
|
|
.
|
|
.IP "\(bu" 4
|
|
Display all plugins by name and format into multiple columns\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search \-\-name | column
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Display all plugins by url, sans \fIhttps://github\.com/\fR and format into multiple columns\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search \-\-field=url \-\-select=all | sed \'s|https://github\.com/||\' | column
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Display all remote plugins by name tagged as \fIa\fR or \fIb\fR\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search \-\-select=remote \-\-name \-\-tag=github \-\-or \-\-tag=tool
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Search plugins from a list of one or more urls and / or names and display their authors\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search $urls $names \-\-url
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "\(bu" 4
|
|
Search all plugins in the cache whose name does not start with the letter \fBs\fR\.
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.IP "" 4
|
|
.
|
|
.nf
|
|
|
|
fisher search \-\-select=cache \-\-name~/^[^s]/
|
|
.
|
|
.fi
|
|
.
|
|
.IP "" 0
|
|
.
|
|
.SH "SEE ALSO"
|
|
\fBfisher\fR(1)
|
|
.
|
|
.br
|
|
\fBfisher\fR(7){\fBIndex\fR}
|
|
.
|
|
.br
|
|
\fBfisher help plugins\fR
|
|
.
|
|
.br
|
|
|