git-bug/doc/md/git-bug_ls.md
vince de5565b5f9
ls: Add support to ls dump bug information in specific formats
This adds an optional flag to the ls command that allows users to specify the format they wish to dump the output as. Currently, supported parameters are 'default', 'plain' and 'json'.
2020-06-16 15:05:48 +02:00

46 lines
1.3 KiB
Markdown

## git-bug ls
List bugs.
### Synopsis
Display a summary of each bugs.
You can pass an additional query to filter and order the list. This query can be expressed either with a simple query language or with flags.
```
git-bug ls [<query>] [flags]
```
### Examples
```
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
```
### Options
```
-s, --status strings Filter by status. Valid values are [open,closed]
-a, --author strings Filter by author
-p, --participant strings Filter by participant
-A, --actor strings Filter by actor
-l, --label strings Filter by label
-t, --title strings Filter by title
-n, --no strings Filter by absence of something. Valid values are [label]
-b, --by string Sort the results by a characteristic. Valid values are [id,creation,edit] (default "creation")
-d, --direction string Select the sorting direction. Valid values are [asc,desc] (default "asc")
-f, --format string Select the output formatting style. Valid values are [default, plain(text), json] (default "default")
-h, --help help for ls
```
### SEE ALSO
* [git-bug](git-bug.md) - A bug tracker embedded in Git.