diff options
Diffstat (limited to 'devdocs/docker/engine%2Freference%2Fcommandline%2Fsearch%2Findex.html')
| -rw-r--r-- | devdocs/docker/engine%2Freference%2Fcommandline%2Fsearch%2Findex.html | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/devdocs/docker/engine%2Freference%2Fcommandline%2Fsearch%2Findex.html b/devdocs/docker/engine%2Freference%2Fcommandline%2Fsearch%2Findex.html new file mode 100644 index 00000000..1272fa6f --- /dev/null +++ b/devdocs/docker/engine%2Freference%2Fcommandline%2Fsearch%2Findex.html @@ -0,0 +1,79 @@ +<h1>docker search</h1> <p><br></p> <p>Search the Docker Hub for images</p> <h2 id="usage">Usage</h2> <div class="highlight"><pre class="highlight" data-language="">$ docker search [OPTIONS] TERM +</pre></div> <p>Refer to the <a href="#options">options section</a> for an overview of available <a href="#options"><code class="language-plaintext highlighter-rouge">OPTIONS</code></a> for this command.</p> <h2 id="description">Description</h2> <p name="extended-description">Search <a href="https://hub.docker.com">Docker Hub</a> for images</p> <p>For example uses of this command, refer to the <a href="#examples">examples section</a> below.</p> <h2 id="options">Options</h2> <table> <thead> <tr> <td>Name, shorthand</td> <td>Default</td> <td>Description</td> </tr> </thead> <tbody> <tr> <td> +<code class="language-plaintext highlighter-rouge">--filter</code> , <code class="language-plaintext highlighter-rouge">-f</code> +</td> <td></td> <td>Filter output based on conditions provided</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--format</code></td> <td></td> <td>Pretty-print search using a Go template</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--limit</code></td> <td><code class="language-plaintext highlighter-rouge">25</code></td> <td>Max number of search results</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">--no-trunc</code></td> <td></td> <td>Don't truncate output</td> </tr> </tbody> </table> <h2 id="examples">Examples</h2> <h3 id="search-images-by-name">Search images by name</h3> <p>This example displays images with a name containing ‘busybox’:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker search busybox + +NAME DESCRIPTION STARS OFFICIAL AUTOMATED +busybox Busybox base image. 316 [OK] +progrium/busybox 50 [OK] +radial/busyboxplus Full-chain, Internet enabled, busybox made... 8 [OK] +odise/busybox-python 2 [OK] +azukiapp/busybox This image is meant to be used as the base... 2 [OK] +ofayau/busybox-jvm Prepare busybox to install a 32 bits JVM. 1 [OK] +shingonoide/archlinux-busybox Arch Linux, a lightweight and flexible Lin... 1 [OK] +odise/busybox-curl 1 [OK] +ofayau/busybox-libc32 Busybox with 32 bits (and 64 bits) libs 1 [OK] +peelsky/zulu-openjdk-busybox 1 [OK] +skomma/busybox-data Docker image suitable for data volume cont... 1 [OK] +elektritter/busybox-teamspeak Lightweight teamspeak3 container based on... 1 [OK] +socketplane/busybox 1 [OK] +oveits/docker-nginx-busybox This is a tiny NginX docker image based on... 0 [OK] +ggtools/busybox-ubuntu Busybox ubuntu version with extra goodies 0 [OK] +nikfoundas/busybox-confd Minimal busybox based distribution of confd 0 [OK] +openshift/busybox-http-app 0 [OK] +jllopis/busybox 0 [OK] +swyckoff/busybox 0 [OK] +powellquiring/busybox 0 [OK] +williamyeh/busybox-sh Docker image for BusyBox's sh 0 [OK] +simplexsys/busybox-cli-powered Docker busybox images, with a few often us... 0 [OK] +fhisamoto/busybox-java Busybox java 0 [OK] +scottabernethy/busybox 0 [OK] +marclop/busybox-solr +</pre></div> <h3 id="display-non-truncated-description---no-trunc">Display non-truncated description (--no-trunc)</h3> <p>This example displays images with a name containing ‘busybox’, at least 3 stars and the description isn’t truncated in the output:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker search --filter=stars=3 --no-trunc busybox + +NAME DESCRIPTION STARS OFFICIAL AUTOMATED +busybox Busybox base image. 325 [OK] +progrium/busybox 50 [OK] +radial/busyboxplus Full-chain, Internet enabled, busybox made from scratch. Comes in git and cURL flavors. 8 [OK] +</pre></div> <h3 id="limit-search-results---limit">Limit search results (--limit)</h3> <p>The flag <code class="language-plaintext highlighter-rouge">--limit</code> is the maximum number of results returned by a search. This value could be in the range between 1 and 100. The default value of <code class="language-plaintext highlighter-rouge">--limit</code> is 25.</p> <h3 id="filtering">Filtering</h3> <p>The filtering flag (<code class="language-plaintext highlighter-rouge">-f</code> or <code class="language-plaintext highlighter-rouge">--filter</code>) format is a <code class="language-plaintext highlighter-rouge">key=value</code> pair. If there is more than one filter, then pass multiple flags (e.g. <code class="language-plaintext highlighter-rouge">--filter is-automated=true --filter stars=3</code>)</p> <p>The currently supported filters are:</p> <ul> <li>stars (int - number of stars the image has)</li> <li>is-automated (boolean - true or false) - is the image automated or not</li> <li>is-official (boolean - true or false) - is the image official or not</li> </ul> <h4 id="stars">stars</h4> <p>This example displays images with a name containing ‘busybox’ and at least 3 stars:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker search --filter stars=3 busybox + +NAME DESCRIPTION STARS OFFICIAL AUTOMATED +busybox Busybox base image. 325 [OK] +progrium/busybox 50 [OK] +radial/busyboxplus Full-chain, Internet enabled, busybox made... 8 [OK] +</pre></div> <h4 id="is-automated">is-automated</h4> <p>This example displays images with a name containing ‘busybox’ and are automated builds:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker search --filter is-automated=true busybox + +NAME DESCRIPTION STARS OFFICIAL AUTOMATED +progrium/busybox 50 [OK] +radial/busyboxplus Full-chain, Internet enabled, busybox made... 8 [OK] +</pre></div> <h4 id="is-official">is-official</h4> <p>This example displays images with a name containing ‘busybox’, at least 3 stars and are official builds:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker search --filter is-official=true --filter stars=3 busybox + +NAME DESCRIPTION STARS OFFICIAL AUTOMATED +busybox Busybox base image. 325 [OK] +</pre></div> <h3 id="format-the-output">Format the output</h3> <p>The formatting option (<code class="language-plaintext highlighter-rouge">--format</code>) pretty-prints search output using a Go template.</p> <p>Valid placeholders for the Go template are:</p> <table> <thead> <tr> <th>Placeholder</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code class="language-plaintext highlighter-rouge">.Name</code></td> <td>Image Name</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">.Description</code></td> <td>Image description</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">.StarCount</code></td> <td>Number of stars for the image</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">.IsOfficial</code></td> <td>“OK” if image is official</td> </tr> <tr> <td><code class="language-plaintext highlighter-rouge">.IsAutomated</code></td> <td>“OK” if image build was automated</td> </tr> </tbody> </table> <p>When you use the <code class="language-plaintext highlighter-rouge">--format</code> option, the <code class="language-plaintext highlighter-rouge">search</code> command will output the data exactly as the template declares. If you use the <code class="language-plaintext highlighter-rouge">table</code> directive, column headers are included as well.</p> <p>The following example uses a template without headers and outputs the <code class="language-plaintext highlighter-rouge">Name</code> and <code class="language-plaintext highlighter-rouge">StarCount</code> entries separated by a colon (<code class="language-plaintext highlighter-rouge">:</code>) for all images:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker search --format "{{.Name}}: {{.StarCount}}" nginx + +nginx: 5441 +jwilder/nginx-proxy: 953 +richarvey/nginx-php-fpm: 353 +million12/nginx-php: 75 +webdevops/php-nginx: 70 +h3nrik/nginx-ldap: 35 +bitnami/nginx: 23 +evild/alpine-nginx: 14 +million12/nginx: 9 +maxexcloo/nginx: 7 +</pre></div> <p>This example outputs a table format:</p> <div class="highlight"><pre class="highlight" data-language="">$ docker search --format "table {{.Name}}\t{{.IsAutomated}}\t{{.IsOfficial}}" nginx + +NAME AUTOMATED OFFICIAL +nginx [OK] +jwilder/nginx-proxy [OK] +richarvey/nginx-php-fpm [OK] +jrcs/letsencrypt-nginx-proxy-companion [OK] +million12/nginx-php [OK] +webdevops/php-nginx [OK] +</pre></div> <div class="_attribution"> + <p class="_attribution-p"> + © 2019 Docker, Inc.<br>Licensed under the Apache License, Version 2.0.<br>Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.<br>Docker, Inc. and other parties may also have trademark rights in other terms used herein.<br> + <a href="https://docs.docker.com/engine/reference/commandline/search/" class="_attribution-link">https://docs.docker.com/engine/reference/commandline/search/</a> + </p> +</div> |