aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMiklos Vajna <vmiklos@collabora.com>2021-03-07 14:09:15 +0100
committerMiklos Vajna <vmiklos@collabora.com>2021-03-07 14:11:04 +0100
commit626ec9835b4450fb2994ec931357279700437b6b (patch)
tree983dbee41bacb6614e0fe5ffb6318dfc2754c7ae /doc
parent87bc42fb4695872b82cfa9a922d423df7ff21132 (diff)
downloadgit-bug-626ec9835b4450fb2994ec931357279700437b6b.tar.gz
webui: allow specifying the initial query
Example use-case: given a github URL in a source code comment or commit message, one can now run: git bug webui --query 'metadata:github-url:"https://github.com/author/myproject/issues/42"' on the commandline to look up the details of that issue on the web ui quickly, offline. Fixes <https://github.com/MichaelMure/git-bug/issues/592>.
Diffstat (limited to 'doc')
-rw-r--r--doc/man/git-bug-webui.14
-rw-r--r--doc/md/git-bug_webui.md13
2 files changed, 11 insertions, 6 deletions
diff --git a/doc/man/git-bug-webui.1 b/doc/man/git-bug-webui.1
index 6e4622be..6bed9143 100644
--- a/doc/man/git-bug-webui.1
+++ b/doc/man/git-bug-webui.1
@@ -42,6 +42,10 @@ Available git config:
Whether to run the web UI in read\-only mode
.PP
+\fB\-\-query\fP=""
+ Set a custom query
+
+.PP
\fB\-h\fP, \fB\-\-help\fP[=false]
help for webui
diff --git a/doc/md/git-bug_webui.md b/doc/md/git-bug_webui.md
index ccfaff9a..0cdfd517 100644
--- a/doc/md/git-bug_webui.md
+++ b/doc/md/git-bug_webui.md
@@ -17,12 +17,13 @@ git-bug webui [flags]
### Options
```
- --host string Network address or hostname to listen to (default to 127.0.0.1) (default "127.0.0.1")
- --open Automatically open the web UI in the default browser
- --no-open Prevent the automatic opening of the web UI in the default browser
- -p, --port int Port to listen to (default to random available port)
- --read-only Whether to run the web UI in read-only mode
- -h, --help help for webui
+ --host string Network address or hostname to listen to (default to 127.0.0.1) (default "127.0.0.1")
+ --open Automatically open the web UI in the default browser
+ --no-open Prevent the automatic opening of the web UI in the default browser
+ -p, --port int Port to listen to (default to random available port)
+ --read-only Whether to run the web UI in read-only mode
+ --query string Set a custom query
+ -h, --help help for webui
```
### SEE ALSO