fisher/man/man1/fisher-search.1

.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "FISHER\-SEARCH" "1" "February 2016" "" "fisherman"
.
.SH "NAME"
\fBfisher\-search\fR \- Search Plugin Index
.
.SH "SYNOPSIS"
fisher \fBsearch\fR [\fIplugins\fR \.\.\.]
.
.br
fisher \fBsearch\fR [\fB\-\-name|\-\-url|\-\-info|\-\-tag|\-\-author\fR]
.
.br
fisher \fBsearch\fR [\fB\-\-query\fR=\fIfield\fR[\fB&&\fR,\fB||\fR]\fIfield\fR\.\.\.]
.
.br
fisher \fBsearch\fR [\fB\-\-format\fR=\fIoneline\fR|\fIshort\fR|\fIverbose\fR|\fIlongline\fR] [\-\-no\-color]
.
.br
fisher \fBsearch\fR [\fB\-\-and\fR] [\fB\-\-or\fR] [\fB\-\-quiet\fR] [\fB\-\-help\fR]
.
.br
.
.SH "USAGE"
fisher \fBsearch\fR \fIurl\fR
.
.br
fisher \fBsearch\fR \fIname\fR
.
.br
fisher \fBsearch\fR \fIowner/repo\fR
.
.br
fisher \fBsearch\fR \fIquery\fR
.
.br
.
.SH "DESCRIPTION"
Search plugins in the Fisherman index\.
.
.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\.
.
.P
For example:
.
.IP "" 4
.
.nf

name
url
info
tag1 tag2 tag3 \.\.\.
author
.
.fi
.
.IP "" 0
.
.P
See \fIIndex\fR in \fBfisher help tour\fR for more information about the index\.
.
.SH "OPTIONS"
.
.TP
\fB\-\-<field>[=match]\fR
Display index records where \fIfield\fR equals \fImatch\fR\. \fIfield\fR can be any of \fBname\fR, \fBurl\fR, \fBinfo\fR, \fBtag/s\fR or \fBauthor\fR\. If \fImatch\fR is not given, display only the given \fIfield\fR from every record in the index\. Use \fB!=\fR to negate the query\.
.
.TP
\fB\-\-<field>[~/regex/]\fR
Same as \fB\-\-<field>[=regex]\fR, but using Regular Expressions instead of exact matching\. Use \fB!~\fR to negate the query\.
.
.TP
\fB\-a \-\-and\fR
Join the query with a logical AND operator\.
.
.TP
\fB\-o \-\-or\fR
Join the query with a logical OR operator\. This is the default operator\.
.
.TP
\fB\-q \-\-quiet\fR
Enable quiet mode\.
.
.TP
\fB\-h \-\-help\fR
Show help\.
.
.SH "OUTPUT"
Search prints the result records in their original format by default\.
.
.IP "" 4
.
.nf

fisher search shark
shark
https://github\.com/bucaran/shark
Sparkline Generator
chart tool graph sparkline
bucaran
.
.fi
.
.IP "" 0
.
.P
To allow for easier parsing, Search will print results records in the same line when using one or more of the following options: \fB\-\-name\fR, \fB\-\-url\fR, \fB\-\-info\fR, \fB\-\-tags\fR, \fB\-\-author\fR\.
.
.IP "" 4
.
.nf

fisher search shark \-\-name \-\-url \-\-author

shark;https://github\.com/fishery/shark;bucaran
.
.fi
.
.IP "" 0
.
.P
The result set above consists of single line per record, and each record consists of one or more of the specified fields separated by semicolons \fB\';\'\fR\.
.
.SH "EXAMPLES"
.
.IP "\(bu" 4
Display plugins by name and format the result into multiple columns\.
.
.IP "" 0
.
.IP "" 4
.
.nf

fisher search \-\-name | column
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Display plugins by URL, sans \fIhttps://github\.com/\fR and format into multiple columns\.
.
.IP "" 0
.
.IP "" 4
.
.nf

fisher search \-\-field=url | sed \'s|https://github\.com/||\' | column
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Display remote plugins, i\.e, those in the index, but \fInot\fR in the cache\.
.
.IP "" 0
.
.IP "" 4
.
.nf

fisher_search \-\-and \-\-name!=(fisher \-\-list=bare)
.
.fi
.
.IP "" 0
.
.IP "\(bu" 4
Search all plugins whose name does not start with the letter \fBs\fR\.
.
.IP "" 0
.
.IP "" 4
.
.nf

fisher search \-\-name!~/^s/
.
.fi
.
.IP "" 0
.
.SH "SEE ALSO"
fisher(1)
.
.br
fisher help plugins
.
.br