summaryrefslogtreecommitdiff
path: root/doc/man/pkgctl-search.1.asciidoc
blob: 8172b0060382ab4f06804d89396b7023646622bf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
pkgctl-search(1)
================

Name
----
pkgctl-search - Search for an expression across the GitLab packaging group

Synopsis
--------
pkgctl search [OPTIONS] QUERY

Description
-----------

Search for an expression across the GitLab packaging group.

To use a filter, include it in your query. You may use wildcards (*) to
use glob matching.

Available filters for the blobs scope: path, extension

Every usage of the search command must be authenticated. Consult the
`'pkgctl auth'` command to authenticate with GitLab or view the authentication
status.

Search Tips
-----------

	Syntax  Description    Example
	───────────────────────────────────────
	"       Exact search   "gem sidekiq"
	~       Fuzzy search   J~ Doe
	|       Or             display | banner
	+       And            display +banner
	-       Exclude        display -banner
	*       Partial        bug error 50*
	\       Escape         \*md
	#       Issue ID       #23456
	!       Merge request  !23456

Options
-------

*-h, --help*::
	Show a help text

Filter Options
--------------

*--no-default-filter*::
	Do not apply default filter (like -path:keys/pgp/*.asc)

Output Options
--------------

*--json*::
	Enable printing in JSON; Shorthand for `'--format json'`

*-F, --format* 'FORMAT'::
	Controls the formatting of the results; `FORMAT` is `'pretty'`, `'plain'`,
	or `'json'` (default `pretty`)

*-N, --no-line-number*::
	Don't show line numbers when formatting results

See Also
--------

linkman:pkgctl-auth[1]

include::include/footer.asciidoc[]