Browse code

Merge pull request #18366 from thaJeztah/carry-17293-add-examples-in-search

Carry 17293 add examples in search

Sebastiaan van Stijn authored on 2015/12/03 05:52:52
Showing 1 changed files
... ...
@@ -26,3 +26,72 @@ more details on finding shared images from the command line.
26 26
 
27 27
 > **Note:**
28 28
 > Search queries will only return up to 25 results
29
+
30
+## Examples
31
+
32
+### Search images by name
33
+
34
+This example displays images with a name containing 'busybox':
35
+
36
+    $ docker search busybox
37
+    NAME                             DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
38
+    busybox                          Busybox base image.                             316       [OK]       
39
+    progrium/busybox                                                                 50                   [OK]
40
+    radial/busyboxplus               Full-chain, Internet enabled, busybox made...   8                    [OK]
41
+    odise/busybox-python                                                             2                    [OK]
42
+    azukiapp/busybox                 This image is meant to be used as the base...   2                    [OK]
43
+    ofayau/busybox-jvm               Prepare busybox to install a 32 bits JVM.       1                    [OK]
44
+    shingonoide/archlinux-busybox    Arch Linux, a lightweight and flexible Lin...   1                    [OK]
45
+    odise/busybox-curl                                                               1                    [OK]
46
+    ofayau/busybox-libc32            Busybox with 32 bits (and 64 bits) libs         1                    [OK]
47
+    peelsky/zulu-openjdk-busybox                                                     1                    [OK]
48
+    skomma/busybox-data              Docker image suitable for data volume cont...   1                    [OK]
49
+    elektritter/busybox-teamspeak    Leightweight teamspeak3 container based on...   1                    [OK]
50
+    socketplane/busybox                                                              1                    [OK]
51
+    oveits/docker-nginx-busybox      This is a tiny NginX docker image based on...   0                    [OK]
52
+    ggtools/busybox-ubuntu           Busybox ubuntu version with extra goodies       0                    [OK]
53
+    nikfoundas/busybox-confd         Minimal busybox based distribution of confd     0                    [OK]
54
+    openshift/busybox-http-app                                                       0                    [OK]
55
+    jllopis/busybox                                                                  0                    [OK]
56
+    swyckoff/busybox                                                                 0                    [OK]
57
+    powellquiring/busybox                                                            0                    [OK]
58
+    williamyeh/busybox-sh            Docker image for BusyBox's sh                   0                    [OK]
59
+    simplexsys/busybox-cli-powered   Docker busybox images, with a few often us...   0                    [OK]
60
+    fhisamoto/busybox-java           Busybox java                                    0                    [OK]
61
+    scottabernethy/busybox                                                           0                    [OK]
62
+    marclop/busybox-solr
63
+
64
+### Search images by name and number of stars (-s, --stars)
65
+
66
+This example displays images with a name containing 'busybox' and at
67
+least 3 stars:
68
+
69
+    $ docker search --stars=3 busybox
70
+    NAME                 DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
71
+    busybox              Busybox base image.                             325       [OK]       
72
+    progrium/busybox                                                     50                   [OK]
73
+    radial/busyboxplus   Full-chain, Internet enabled, busybox made...   8                    [OK]
74
+
75
+
76
+### Search automated images (--automated)
77
+
78
+This example displays images with a name containing 'busybox', at
79
+least 3 stars and are automated builds:
80
+
81
+    $ docker search --stars=3 --automated busybox
82
+    NAME                 DESCRIPTION                                     STARS     OFFICIAL   AUTOMATED
83
+    progrium/busybox                                                     50                   [OK]
84
+    radial/busyboxplus   Full-chain, Internet enabled, busybox made...   8                    [OK]
85
+
86
+
87
+### Display non-truncated description (--no-trunc)
88
+
89
+This example displays images with a name containing 'busybox',
90
+at least 3 stars and the description isn't truncated in the output:
91
+
92
+    $ docker search --stars=3 --no-trunc busybox
93
+    NAME                 DESCRIPTION                                                                               STARS     OFFICIAL   AUTOMATED
94
+    busybox              Busybox base image.                                                                       325       [OK]       
95
+    progrium/busybox                                                                                               50                   [OK]
96
+    radial/busyboxplus   Full-chain, Internet enabled, busybox made from scratch. Comes in git and cURL flavors.   8                    [OK]
97
+