1podman-search(1)() podman-search(1)()
2
6 podman-search - Search a registry for an image
7
10 podman search [options] term
11
14 podman search searches a registry or a list of registries for a match‐
15 ing image. The user can specify which registry to search by prefixing
16 the registry in the search term (e.g., registry.fedoraproject.org/fe‐
17 dora). By default, all unqualified-search registries in containers-
18 registries.conf(5) are used.
19 The default number of results is 25. The number of results can be lim‐
22 ited using the --limit flag. If more than one registry is being
23 searched, the limit will be applied to each registry. The output can be
24 filtered using the --filter flag. To get all available images in a reg‐
25 istry without a specific search term, the user can just enter the reg‐
26 istry name with a trailing "/" (example registry.fedoraproject.org/).
27 Note that podman search is not a reliable way to determine the presence
30 or existence of an image. The search behavior of the v1 and v2 Docker
31 distribution API is specific to the implementation of each registry.
32 Some registries may not support searching at all. Further note that
33 searching without a search term will only work for registries that im‐
34 plement the v2 API.
35 podman [GLOBAL OPTIONS]
38 podman search [GLOBAL OPTIONS]
41 podman search [OPTIONS] TERM
44
47 --authfile=path
48 Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/contain‐
49 ers/auth.json
50 Note: You can also override the default path of the authentication file
53 by setting the REGISTRY_AUTH_FILE environment variable. export REG‐
54 ISTRY_AUTH_FILE=path
55 --compatible
58 After the name and the description, also show the stars, official and
59 automated descriptors as Docker does. Podman does not show these de‐
60 scriptors by default since they are not supported by most public con‐
61 tainer registries.
62 --filter, -f=filter
65 Filter output based on conditions provided (default [])
66 Supported filters are:
69 • stars (int - number of stars the image has)
72 • is-automated (boolean - true | false) - is the image automated
74 or not
75 • is-official (boolean - true | false) - is the image official
77 or not
78 --format=format
82 Change the output format to a Go template
83 Valid placeholders for the Go template are listed below:
86 ┌─────────────┬──────────────────────────────┐
89 │Placeholder │ Description │
90 ├─────────────┼──────────────────────────────┤
91 │.Index │ Registry │
92 ├─────────────┼──────────────────────────────┤
93 │.Name │ Image name │
94 ├─────────────┼──────────────────────────────┤
95 │.Description │ Image description │
96 ├─────────────┼──────────────────────────────┤
97 │.Stars │ Star count of image │
98 ├─────────────┼──────────────────────────────┤
99 │.Official │ "[OK]" if image is official │
100 ├─────────────┼──────────────────────────────┤
101 │.Automated │ "[OK]" if image is automated │
102 ├─────────────┼──────────────────────────────┤
103 │.Tag │ Repository tag │
104 └─────────────┴──────────────────────────────┘
105 Note: use .Tag only if the --list-tags is set.
107 --help, -h
110 Print usage statement
111 --limit=limit
114 Limit the number of results (default 25). Note: The results from each
115 registry will be limited to this value. Example if limit is 10 and two
116 registries are being searched, the total number of results will be 20,
117 10 from each (if there are at least 10 matches in each). The order of
118 the search results is the order in which the API endpoint returns the
119 results.
120 --list-tags
123 List the available tags in the repository for the specified image.
124 Note: --list-tags requires the search term to be a fully specified im‐
125 age name. The result contains the Image name and its tag, one line for
126 every tag associated with the image.
127 --no-trunc
130 Do not truncate the output (default false).
131 --tls-verify
134 Require HTTPS and verify certificates when contacting registries (de‐
135 fault: true). If explicitly set to true, then TLS verification will be
136 used. If set to false, then TLS verification will not be used if
137 needed. If not specified, default registries will be searched through
138 (in /etc/containers/registries.conf), and TLS will be skipped if a de‐
139 fault registry is listed in the insecure registries.
140
143 $ podman search --limit 3 fedora
144 NAME DESCRIPTION
145 registry.centos.org/centos
146 registry.centos.org/cdrage/mosh-centos7
147 registry.centos.org/centos/bind
148 docker.io/library/centos The official build of CentOS.
149 docker.io/jdeathe/centos-ssh OpenSSH / Supervisor / EPEL/IUS/SCL Repos - ...
150 docker.io/ansible/centos7-ansible Ansible on Centos7
151 quay.io/centos/centos The official CentOS base containers.
152 quay.io/ukhomeofficedigital/centos-base
153 quay.io/quarkus/centos-quarkus-maven Quarkus.io builder image for building Quarku...
154 Note that the Stars, Official and Automated descriptors are only avail‐
158 able on Docker Hub and are hence not displayed by default.
159 $ podman search --format "{{.Name}}\t{{.Stars}}\t{{.Official}}" alpine --limit 3
162 docker.io/library/alpine 7956 [OK]
163 docker.io/alpine/git 192
164 docker.io/anapsix/alpine-java 474
165 quay.io/libpod/alpine 0
166 quay.io/vqcomms/alpine-tools 0
167 quay.io/wire/alpine-deps 0
168 $ podman search --list-tags registry.access.redhat.com/ubi8 --limit 4
172 NAME TAG
173 registry.access.redhat.com/ubi8 8.4-211
174 registry.access.redhat.com/ubi8 8.4-206.1626828523-source
175 registry.access.redhat.com/ubi8 8.4-199
176 registry.access.redhat.com/ubi8 8.4-211-source
177 Note: This works only with registries that implement the v2 API. If
182 tried with a v1 registry an error will be returned.
183
186 registries.conf (/etc/containers/registries.conf)
187 registries.conf is the configuration file which specifies which con‐
190 tainer registries should be consulted when completing image names which
191 do not include a registry or domain portion.
192
195 podman(1), containers-registries(5)
196
199 January 2018, Originally compiled by Urvashi Mohnani umohnani@red‐
200 hat.com ⟨mailto:umohnani@redhat.com⟩
201 podman-search(1)()