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 is applied to each registry. The output can be fil‐
24 tered 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 only works for registries that imple‐
34 ment 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 on Linux, and $HOME/.config/containers/auth.json on Win‐
50 dows/macOS. The file is created by podman login. If the authorization
51 state is not found there, $HOME/.docker/config.json is checked, which
52 is set using docker login.
53 Note: There is also the option to override the default path of the au‐
56 thentication file by setting the REGISTRY_AUTH_FILE environment vari‐
57 able. This can be done with export REGISTRY_AUTH_FILE=path.
58 --cert-dir=path
61 Use certificates at path (*.crt, *.cert, *.key) to connect to the reg‐
62 istry. (Default: /etc/containers/certs.d) For details, see containers-
63 certs.d(5). (This option is not available with the remote Podman
64 client, including Mac and Windows (excluding WSL2) machines)
65 --compatible
68 After the name and the description, also show the stars, official and
69 automated descriptors as Docker does. Podman does not show these de‐
70 scriptors by default since they are not supported by most public con‐
71 tainer registries.
72 --creds=[username[:password]]
75 The [username[:password]] to use to authenticate with the registry, if
76 required. If one or both values are not supplied, a command line
77 prompt appears and the value can be entered. The password is entered
78 without echo.
79 Note that the specified credentials are only used to authenticate
82 against target registries. They are not used for mirrors or when the
83 registry gets rewritten (see containers-registries.conf(5)); to authen‐
84 ticate against those consider using a containers-auth.json(5) file.
85 --filter, -f=filter
88 Filter output based on conditions provided (default [])
89 Supported filters are:
92 • stars (int - number of stars the image has)
95 • is-automated (boolean - true | false) - is the image automated
97 or not
98 • is-official (boolean - true | false) - is the image official
100 or not
101 --format=format
105 Change the output format to a Go template
106 Valid placeholders for the Go template are listed below:
109 ┌─────────────┬──────────────────────────────┐
112 │Placeholder │ Description │
113 ├─────────────┼──────────────────────────────┤
114 │.Automated │ "[OK]" if image is automated │
115 ├─────────────┼──────────────────────────────┤
116 │.Description │ Image description │
117 ├─────────────┼──────────────────────────────┤
118 │.Index │ Registry │
119 ├─────────────┼──────────────────────────────┤
120 │.Name │ Image name │
121 ├─────────────┼──────────────────────────────┤
122 │.Official │ "[OK]" if image is official │
123 ├─────────────┼──────────────────────────────┤
124 │.Stars │ Star count of image │
125 ├─────────────┼──────────────────────────────┤
126 │.Tag │ Repository tag │
127 └─────────────┴──────────────────────────────┘
128 Note: use .Tag only if the --list-tags is set.
130 --help, -h
133 Print usage statement
134 --limit=limit
137 Limit the number of results (default 25). Note: The results from each
138 registry is limited to this value. Example if limit is 10 and two reg‐
139 istries are being searched, the total number of results is 20, 10 from
140 each (if there are at least 10 matches in each). The order of the
141 search results is the order in which the API endpoint returns the re‐
142 sults.
143 --list-tags
146 List the available tags in the repository for the specified image.
147 Note: --list-tags requires the search term to be a fully specified im‐
148 age name. The result contains the Image name and its tag, one line for
149 every tag associated with the image.
150 --no-trunc
153 Do not truncate the output (default false).
154 --tls-verify
157 Require HTTPS and verify certificates when contacting registries (de‐
158 fault: true). If explicitly set to true, TLS verification is used. If
159 set to false, TLS verification is not used. If not specified, TLS ver‐
160 ification is used unless the target registry is listed as an insecure
161 registry in containers-registries.conf(5)
162
165 $ podman search --limit 3 fedora
166 NAME DESCRIPTION
167 registry.centos.org/centos
168 registry.centos.org/cdrage/mosh-centos7
169 registry.centos.org/centos/bind
170 docker.io/library/centos The official build of CentOS.
171 docker.io/jdeathe/centos-ssh OpenSSH / Supervisor / EPEL/IUS/SCL Repos - ...
172 docker.io/ansible/centos7-ansible Ansible on Centos7
173 quay.io/centos/centos The official CentOS base containers.
174 quay.io/ukhomeofficedigital/centos-base
175 quay.io/quarkus/centos-quarkus-maven Quarkus.io builder image for building Quarku...
176 Note that the Stars, Official and Automated descriptors are only avail‐
180 able on Docker Hub and are hence not displayed by default.
181 $ podman search --format "{{.Name}}\t{{.Stars}}\t{{.Official}}" alpine --limit 3
183 docker.io/library/alpine 7956 [OK]
184 docker.io/alpine/git 192
185 docker.io/anapsix/alpine-java 474
186 quay.io/libpod/alpine 0
187 quay.io/vqcomms/alpine-tools 0
188 quay.io/wire/alpine-deps 0
189 $ podman search --list-tags registry.access.redhat.com/ubi8 --limit 4
192 NAME TAG
193 registry.access.redhat.com/ubi8 8.4-211
194 registry.access.redhat.com/ubi8 8.4-206.1626828523-source
195 registry.access.redhat.com/ubi8 8.4-199
196 registry.access.redhat.com/ubi8 8.4-211-source
197 Note: This works only with registries that implement the v2 API. If
202 tried with a v1 registry an error is returned.
203
206 registries.conf (/etc/containers/registries.conf)
207 registries.conf is the configuration file which specifies which con‐
210 tainer registries is consulted when completing image names which do not
211 include a registry or domain portion.
212
215 podman(1), containers-registries(5)
216
219 January 2018, Originally compiled by Urvashi Mohnani umohnani@red‐
220 hat.com ⟨mailto:umohnani@redhat.com⟩
221 podman-search(1)