aboutsummaryrefslogtreecommitdiffstats
path: root/doc/md/git-bug_ls.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/md/git-bug_ls.md')
-rw-r--r--doc/md/git-bug_ls.md27
1 files changed, 23 insertions, 4 deletions
diff --git a/doc/md/git-bug_ls.md b/doc/md/git-bug_ls.md
index 5b89fabb..53f9b7f4 100644
--- a/doc/md/git-bug_ls.md
+++ b/doc/md/git-bug_ls.md
@@ -1,19 +1,38 @@
## git-bug ls
-Display a summary of all bugs
+List bugs
### Synopsis
-Display a summary of all bugs
+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]
```
-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
```
- -h, --help help for ls
+ -s, --status strings Filter by status. Valid values are [open,closed]
+ -a, --author strings Filter by author
+ -l, --label strings Filter by label
+ -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")
+ -h, --help help for ls
```
### SEE ALSO