github.com/yogeshlonkar/moby@v1.13.2-0.20201203103638-c0b64beaea94/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  ## Description
    34  
    35  Search [Docker Hub](https://hub.docker.com) for images
    36  
    37  See [*Find Public Images on Docker Hub*](https://docs.docker.com/engine/tutorials/dockerrepos/#searching-for-images) for
    38  more details on finding shared images from the command line.
    39  
    40  > **Note**: Search queries return a maximum of 25 results.
    41  
    42  ## Examples
    43  
    44  ### Search images by name
    45  
    46  This example displays images with a name containing 'busybox':
    47  
    48  ```none
    49  $ docker search busybox
    50  
    51  NAME                             DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
    52  busybox                          Busybox base image.                             316       [OK]       
    53  progrium/busybox                                                                 50                   [OK]
    54  radial/busyboxplus               Full-chain, Internet enabled, busybox made...   8                    [OK]
    55  odise/busybox-python                                                             2                    [OK]
    56  azukiapp/busybox                 This image is meant to be used as the base...   2                    [OK]
    57  ofayau/busybox-jvm               Prepare busybox to install a 32 bits JVM.       1                    [OK]
    58  shingonoide/archlinux-busybox    Arch Linux, a lightweight and flexible Lin...   1                    [OK]
    59  odise/busybox-curl                                                               1                    [OK]
    60  ofayau/busybox-libc32            Busybox with 32 bits (and 64 bits) libs         1                    [OK]
    61  peelsky/zulu-openjdk-busybox                                                     1                    [OK]
    62  skomma/busybox-data              Docker image suitable for data volume cont...   1                    [OK]
    63  elektritter/busybox-teamspeak    Lightweight teamspeak3 container based on...    1                    [OK]
    64  socketplane/busybox                                                              1                    [OK]
    65  oveits/docker-nginx-busybox      This is a tiny NginX docker image based on...   0                    [OK]
    66  ggtools/busybox-ubuntu           Busybox ubuntu version with extra goodies       0                    [OK]
    67  nikfoundas/busybox-confd         Minimal busybox based distribution of confd     0                    [OK]
    68  openshift/busybox-http-app                                                       0                    [OK]
    69  jllopis/busybox                                                                  0                    [OK]
    70  swyckoff/busybox                                                                 0                    [OK]
    71  powellquiring/busybox                                                            0                    [OK]
    72  williamyeh/busybox-sh            Docker image for BusyBox's sh                   0                    [OK]
    73  simplexsys/busybox-cli-powered   Docker busybox images, with a few often us...   0                    [OK]
    74  fhisamoto/busybox-java           Busybox java                                    0                    [OK]
    75  scottabernethy/busybox                                                           0                    [OK]
    76  marclop/busybox-solr
    77  ```
    78  
    79  ### Display non-truncated description (--no-trunc)
    80  
    81  This example displays images with a name containing 'busybox',
    82  at least 3 stars and the description isn't truncated in the output:
    83  
    84  ```bash
    85  $ docker search --stars=3 --no-trunc busybox
    86  NAME                 DESCRIPTION                                                                               STARS     OFFICIAL   AUTOMATED
    87  busybox              Busybox base image.                                                                       325       [OK]       
    88  progrium/busybox                                                                                               50                   [OK]
    89  radial/busyboxplus   Full-chain, Internet enabled, busybox made from scratch. Comes in git and cURL flavors.   8                    [OK]
    90  ```
    91  
    92  ### Limit search results (--limit)
    93  
    94  The flag `--limit` is the maximum number of results returned by a search. This value could
    95  be in the range between 1 and 100. The default value of `--limit` is 25.
    96  
    97  
    98  ### Filtering
    99  
   100  The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there is more
   101  than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`)
   102  
   103  The currently supported filters are:
   104  
   105  * stars (int - number of stars the image has)
   106  * is-automated (true|false) - is the image automated or not
   107  * is-official (true|false) - is the image official or not
   108  
   109  
   110  #### stars
   111  
   112  This example displays images with a name containing 'busybox' and at
   113  least 3 stars:
   114  
   115  ```bash
   116  $ docker search --filter stars=3 busybox
   117  
   118  NAME                 DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
   119  busybox              Busybox base image.                             325       [OK]       
   120  progrium/busybox                                                     50                   [OK]
   121  radial/busyboxplus   Full-chain, Internet enabled, busybox made...   8                    [OK]
   122  ```
   123  
   124  
   125  #### is-automated
   126  
   127  This example displays images with a name containing 'busybox'
   128  and are automated builds:
   129  
   130  ```bash
   131  $ docker search --filter is-automated busybox
   132  
   133  NAME                 DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
   134  progrium/busybox                                                     50                   [OK]
   135  radial/busyboxplus   Full-chain, Internet enabled, busybox made...   8                    [OK]
   136  ```
   137  
   138  #### is-official
   139  
   140  This example displays images with a name containing 'busybox', at least
   141  3 stars and are official builds:
   142  
   143  ```bash
   144  $ docker search --filter "is-official=true" --filter "stars=3" busybox
   145  
   146  NAME                 DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
   147  progrium/busybox                                                     50                   [OK]
   148  radial/busyboxplus   Full-chain, Internet enabled, busybox made...   8                    [OK]
   149  ```