github.com/olljanat/moby@v1.13.1/docs/reference/commandline/search.md (about)

     1  ---
     2  title: "search"
     3  description: "The search command description and usage"
     4  keywords: "search, hub, images"
     5  ---
     6  
     7  <!-- This file is maintained within the docker/docker Github
     8       repository at https://github.com/docker/docker/. Make all
     9       pull requests against that repo. If you see this file in
    10       another repository, consider it read-only there, as it will
    11       periodically be overwritten by the definitive file. Pull
    12       requests which include edits to this file in other repositories
    13       will be rejected.
    14  -->
    15  
    16  # search
    17  
    18  ```markdown
    19  Usage:  docker search [OPTIONS] TERM
    20  
    21  Search the Docker Hub for images
    22  
    23  Options:
    24    -f, --filter value   Filter output based on conditions provided (default [])
    25                         - is-automated=(true|false)
    26                         - is-official=(true|false)
    27                         - stars=<number> - image has at least 'number' stars
    28        --help           Print usage
    29        --limit int      Max number of search results (default 25)
    30        --no-trunc       Don't truncate output
    31  ```
    32  
    33  Search [Docker Hub](https://hub.docker.com) for images
    34  
    35  See [*Find Public Images on Docker Hub*](https://docs.docker.com/engine/tutorials/dockerrepos/#searching-for-images) for
    36  more details on finding shared images from the command line.
    37  
    38  > **Note:**
    39  > Search queries will only return up to 25 results
    40  
    41  ## Examples
    42  
    43  ### Search images by name
    44  
    45  This example displays images with a name containing 'busybox':
    46  
    47      $ docker search busybox
    48      NAME                             DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
    49      busybox                          Busybox base image.                             316       [OK]       
    50      progrium/busybox                                                                 50                   [OK]
    51      radial/busyboxplus               Full-chain, Internet enabled, busybox made...   8                    [OK]
    52      odise/busybox-python                                                             2                    [OK]
    53      azukiapp/busybox                 This image is meant to be used as the base...   2                    [OK]
    54      ofayau/busybox-jvm               Prepare busybox to install a 32 bits JVM.       1                    [OK]
    55      shingonoide/archlinux-busybox    Arch Linux, a lightweight and flexible Lin...   1                    [OK]
    56      odise/busybox-curl                                                               1                    [OK]
    57      ofayau/busybox-libc32            Busybox with 32 bits (and 64 bits) libs         1                    [OK]
    58      peelsky/zulu-openjdk-busybox                                                     1                    [OK]
    59      skomma/busybox-data              Docker image suitable for data volume cont...   1                    [OK]
    60      elektritter/busybox-teamspeak    Lightweight teamspeak3 container based on...    1                    [OK]
    61      socketplane/busybox                                                              1                    [OK]
    62      oveits/docker-nginx-busybox      This is a tiny NginX docker image based on...   0                    [OK]
    63      ggtools/busybox-ubuntu           Busybox ubuntu version with extra goodies       0                    [OK]
    64      nikfoundas/busybox-confd         Minimal busybox based distribution of confd     0                    [OK]
    65      openshift/busybox-http-app                                                       0                    [OK]
    66      jllopis/busybox                                                                  0                    [OK]
    67      swyckoff/busybox                                                                 0                    [OK]
    68      powellquiring/busybox                                                            0                    [OK]
    69      williamyeh/busybox-sh            Docker image for BusyBox's sh                   0                    [OK]
    70      simplexsys/busybox-cli-powered   Docker busybox images, with a few often us...   0                    [OK]
    71      fhisamoto/busybox-java           Busybox java                                    0                    [OK]
    72      scottabernethy/busybox                                                           0                    [OK]
    73      marclop/busybox-solr
    74  
    75  ### Display non-truncated description (--no-trunc)
    76  
    77  This example displays images with a name containing 'busybox',
    78  at least 3 stars and the description isn't truncated in the output:
    79  
    80      $ docker search --stars=3 --no-trunc busybox
    81      NAME                 DESCRIPTION                                                                               STARS     OFFICIAL   AUTOMATED
    82      busybox              Busybox base image.                                                                       325       [OK]       
    83      progrium/busybox                                                                                               50                   [OK]
    84      radial/busyboxplus   Full-chain, Internet enabled, busybox made from scratch. Comes in git and cURL flavors.   8                    [OK]
    85  
    86  ## Limit search results (--limit)
    87  
    88  The flag `--limit` is the maximum number of results returned by a search. This value could
    89  be in the range between 1 and 100. The default value of `--limit` is 25.
    90  
    91  
    92  ## Filtering
    93  
    94  The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more
    95  than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`)
    96  
    97  The currently supported filters are:
    98  
    99  * stars (int - number of stars the image has)
   100  * is-automated (true|false) - is the image automated or not
   101  * is-official (true|false) - is the image official or not
   102  
   103  
   104  ### stars
   105  
   106  This example displays images with a name containing 'busybox' and at
   107  least 3 stars:
   108  
   109      $ docker search --filter stars=3 busybox
   110      NAME                 DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
   111      busybox              Busybox base image.                             325       [OK]       
   112      progrium/busybox                                                     50                   [OK]
   113      radial/busyboxplus   Full-chain, Internet enabled, busybox made...   8                    [OK]
   114  
   115  
   116  ### is-automated
   117  
   118  This example displays images with a name containing 'busybox'
   119  and are automated builds:
   120  
   121      $ docker search --filter is-automated busybox
   122      NAME                 DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
   123      progrium/busybox                                                     50                   [OK]
   124      radial/busyboxplus   Full-chain, Internet enabled, busybox made...   8                    [OK]
   125  
   126  ### is-official
   127  
   128  This example displays images with a name containing 'busybox', at least
   129  3 stars and are official builds:
   130  
   131      $ docker search --filter "is-official=true" --filter "stars=3" busybox
   132      NAME                 DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
   133      progrium/busybox                                                     50                   [OK]
   134      radial/busyboxplus   Full-chain, Internet enabled, busybox made...   8                    [OK]