1podman-search(1) General Commands Manual 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, which is set using podman login. If the authorization
50 state is not found there, $HOME/.docker/config.json is checked, which
51 is set using docker login.
52 Note: There is also the option to override the default path of the au‐
55 thentication file by setting the REGISTRY_AUTH_FILE environment vari‐
56 able. This can be done with export REGISTRY_AUTH_FILE=path.
57 --compatible
60 After the name and the description, also show the stars, official and
61 automated descriptors as Docker does. Podman does not show these de‐
62 scriptors by default since they are not supported by most public con‐
63 tainer registries.
64 --filter, -f=filter
67 Filter output based on conditions provided (default [])
68 Supported filters are:
71 • stars (int - number of stars the image has)
74 • is-automated (boolean - true | false) - is the image automated
76 or not
77 • is-official (boolean - true | false) - is the image official
79 or not
80 --format=format
84 Change the output format to a Go template
85 Valid placeholders for the Go template are listed below:
88 ┌─────────────┬──────────────────────────────┐
91 │Placeholder │ Description │
92 ├─────────────┼──────────────────────────────┤
93 │.Index │ Registry │
94 ├─────────────┼──────────────────────────────┤
95 │.Name │ Image name │
96 ├─────────────┼──────────────────────────────┤
97 │.Description │ Image description │
98 ├─────────────┼──────────────────────────────┤
99 │.Stars │ Star count of image │
100 ├─────────────┼──────────────────────────────┤
101 │.Official │ "[OK]" if image is official │
102 ├─────────────┼──────────────────────────────┤
103 │.Automated │ "[OK]" if image is automated │
104 ├─────────────┼──────────────────────────────┤
105 │.Tag │ Repository tag │
106 └─────────────┴──────────────────────────────┘
107 Note: use .Tag only if the --list-tags is set.
109 --help, -h
112 Print usage statement
113 --limit=limit
116 Limit the number of results (default 25). Note: The results from each
117 registry will be limited to this value. Example if limit is 10 and two
118 registries are being searched, the total number of results will be 20,
119 10 from each (if there are at least 10 matches in each). The order of
120 the search results is the order in which the API endpoint returns the
121 results.
122 --list-tags
125 List the available tags in the repository for the specified image.
126 Note: --list-tags requires the search term to be a fully specified im‐
127 age name. The result contains the Image name and its tag, one line for
128 every tag associated with the image.
129 --no-trunc
132 Do not truncate the output (default false).
133 --tls-verify
136 Require HTTPS and verify certificates when contacting registries (de‐
137 fault: true). If explicitly set to true, TLS verification will be
138 used. If set to false, TLS verification will not be used. If not
139 specified, TLS verification will be used unless the target registry is
140 listed as an insecure registry in containers-registries.conf(5)
141
144 $ podman search --limit 3 fedora
145 NAME DESCRIPTION
146 registry.centos.org/centos
147 registry.centos.org/cdrage/mosh-centos7
148 registry.centos.org/centos/bind
149 docker.io/library/centos The official build of CentOS.
150 docker.io/jdeathe/centos-ssh OpenSSH / Supervisor / EPEL/IUS/SCL Repos - ...
151 docker.io/ansible/centos7-ansible Ansible on Centos7
152 quay.io/centos/centos The official CentOS base containers.
153 quay.io/ukhomeofficedigital/centos-base
154 quay.io/quarkus/centos-quarkus-maven Quarkus.io builder image for building Quarku...
155 Note that the Stars, Official and Automated descriptors are only avail‐
159 able on Docker Hub and are hence not displayed by default.
160 $ podman search --format "{{.Name}}\t{{.Stars}}\t{{.Official}}" alpine --limit 3
163 docker.io/library/alpine 7956 [OK]
164 docker.io/alpine/git 192
165 docker.io/anapsix/alpine-java 474
166 quay.io/libpod/alpine 0
167 quay.io/vqcomms/alpine-tools 0
168 quay.io/wire/alpine-deps 0
169 $ podman search --list-tags registry.access.redhat.com/ubi8 --limit 4
173 NAME TAG
174 registry.access.redhat.com/ubi8 8.4-211
175 registry.access.redhat.com/ubi8 8.4-206.1626828523-source
176 registry.access.redhat.com/ubi8 8.4-199
177 registry.access.redhat.com/ubi8 8.4-211-source
178 Note: This works only with registries that implement the v2 API. If
183 tried with a v1 registry an error will be returned.
184
187 registries.conf (/etc/containers/registries.conf)
188 registries.conf is the configuration file which specifies which con‐
191 tainer registries should be consulted when completing image names which
192 do not include a registry or domain portion.
193
196 podman(1), containers-registries(5)
197
200 January 2018, Originally compiled by Urvashi Mohnani umohnani@red‐
201 hat.com ⟨mailto:umohnani@redhat.com⟩
202 podman-search(1)