github.com/brahmaroutu/docker@v1.2.1-0.20160809185609-eb28dde01f16/docs/reference/commandline/search.md (about)

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