git-bug/doc/man/git-bug-ls.1
Miklos Vajna cb61245078 Add ability to search by arbitrary metadata
Example:

~/git/git-bug/git-bug ls --metadata github-url=https://github.com/author/myproject/issues/42

or

~/git/git-bug/git-bug ls metadata:github-url:\"https://github.com/author/myproject/issues/42\"

Fixes the cmdline part of <https://github.com/MichaelMure/git-bug/issues/567>.
2021-02-21 14:15:50 +01:00

97 lines
1.8 KiB
Groff

.nh
.TH "GIT\-BUG" "1" "Apr 2019" "Generated from git\-bug's source code" ""
.SH NAME
.PP
git\-bug\-ls \- List bugs.
.SH SYNOPSIS
.PP
\fBgit\-bug ls [QUERY] [flags]\fP
.SH DESCRIPTION
.PP
Display a summary of each bugs.
.PP
You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language, flags, a natural language full text search, or a combination of the aforementioned.
.SH OPTIONS
.PP
\fB\-s\fP, \fB\-\-status\fP=[]
Filter by status. Valid values are [open,closed]
.PP
\fB\-a\fP, \fB\-\-author\fP=[]
Filter by author
.PP
\fB\-m\fP, \fB\-\-metadata\fP=[]
Filter by metadata. Example: github\-url=URL
.PP
\fB\-p\fP, \fB\-\-participant\fP=[]
Filter by participant
.PP
\fB\-A\fP, \fB\-\-actor\fP=[]
Filter by actor
.PP
\fB\-l\fP, \fB\-\-label\fP=[]
Filter by label
.PP
\fB\-t\fP, \fB\-\-title\fP=[]
Filter by title
.PP
\fB\-n\fP, \fB\-\-no\fP=[]
Filter by absence of something. Valid values are [label]
.PP
\fB\-b\fP, \fB\-\-by\fP="creation"
Sort the results by a characteristic. Valid values are [id,creation,edit]
.PP
\fB\-d\fP, \fB\-\-direction\fP="asc"
Select the sorting direction. Valid values are [asc,desc]
.PP
\fB\-f\fP, \fB\-\-format\fP="default"
Select the output formatting style. Valid values are [default,plain,json,org\-mode]
.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for ls
.SH EXAMPLE
.PP
.RS
.nf
List open bugs sorted by last edition with a query:
git bug ls status:open sort:edit\-desc
List closed bugs sorted by creation with flags:
git bug ls \-\-status closed \-\-by creation
Do a full text search of all bugs:
git bug ls "foo bar" baz
Use queries, flags, and full text search:
git bug ls status:open \-\-by creation "foo bar" baz
.fi
.RE
.SH SEE ALSO
.PP
\fBgit\-bug(1)\fP