_docker 14.5 KB
Newer Older
Ahmed Azaan's avatar
Ahmed Azaan committed
1
2
3
4
#compdef docker

# Docker autocompletion for oh-my-zsh
# Requires: Docker installed
5
6
# Author: Azaan (@aeonazaan)
# Updates: Bob Maerten (@bobmaerten) for Docker v0.9+
7
#          Paul van den Berg (@bergvandenp) for Docker v1.3+ 
Ahmed Azaan's avatar
Ahmed Azaan committed
8
9
10
11
12
13


# ----- Helper functions
# Output a selectable list of all running docker containers
__docker_containers() {
    declare -a cont_cmd
14
    cont_cmd=($(docker ps | awk 'NR>1{print $NF":[CON("$1")"$2"("$3")]"}'))
15
16
17
18
19
20
21
22
23
24
    if [[  'X$cont_cmd' != 'X' ]]
        _describe 'containers' cont_cmd
}

# Output a selectable list of all containers, even not running
__docker_all_containers() {
    declare -a cont_cmd
    cont_cmd=($(docker ps -a | awk 'NR>1{print $NF":[CON("$1")"$2"("$3")]"}'))
    if [[  'X$cont_cmd' != 'X' ]]
        _describe 'containers' cont_cmd
Ahmed Azaan's avatar
Ahmed Azaan committed
25
26
27
28
29
30
31
32
33
34
35
36
37
}

# output a selectable list of all docker images
__docker_images() {
    declare -a img_cmd
    img_cmd=($(docker images | awk 'NR>1{print $1}'))
    _describe 'images' img_cmd
}

# ----- Commands
# Seperate function for each command, makes extension easier later
# ---------------------------
__attach() {
38
    _arguments \
UserTaken's avatar
UserTaken committed
39
        '--no-stdin[Do not attach STDIN]' \
40
        '--sig-proxy[Proxify all received signal to the process (even in non-tty mode)]'
Ahmed Azaan's avatar
Ahmed Azaan committed
41
42
43
44
45
    __docker_containers
}

__build() {
    _arguments \
46
47
48
49
        '--no-cache[Do not use cache when building the image]' \
        '(-q,--quiet)'{-q,--quiet}'[Suppress the verbose output generated by the containers]' \
        '--rm[Remove intermediate containers after a successful build]' \
        '(-t,--tag=)'{-t,--tag=}'[Repository name (and optionally a tag) to be applied to the resulting image in case of success]' \
Ahmed Azaan's avatar
Ahmed Azaan committed
50
        '*:files:_files'
Ahmed Azaan's avatar
Ahmed Azaan committed
51
52
53
54
}

__commit() {
    _arguments \
UserTaken's avatar
UserTaken committed
55
56
        '(-a,--author=)'{-a,--author=}'[Author (e.g. "John Hannibal Smith <hannibal@a-team.com>")]' \
        '(-c,--change=)'{-c,--change=}'[Apply Dockerfile instruction to the created image]' \
57
        '(-m,--message=)'{-m,--message=}'[Commit message]' \
UserTaken's avatar
UserTaken committed
58
        '(-p,--pause=)'{-p,--pause=}'[Pause container during commit]' \
59
60
61
}

__cp() {
Ahmed Azaan's avatar
Ahmed Azaan committed
62
63
64
    __docker_containers
}

UserTaken's avatar
UserTaken committed
65
66
67
68
69
70
71
__create() {
    _arguments \
        '(-P,--publish-all=)'{-P,--publish-all=}'[Publish all exposed ports to the host interfaces]' \
        '(-a,--attach=)'{-a,--attach=}'[Attach to STDIN, STDOUT or STDERR]' \
        '--add-host=[Add a custom host-to-IP mapping]' \
        '--cap-add=[Add Linux capabilities]' \
        '--cap-drop=[Drop Linux capabilities]' \
UserTaken's avatar
UserTaken committed
72
73
        '--cpuset-cpus=[CPUs in which to allow execution (0-3, 0,1)]' \
        '(-c,--cpu-shares=)'{-c,--cpu-shares=}'[CPU shares (relative weight)]' \
UserTaken's avatar
UserTaken committed
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
        '--cidfile=[Write the container ID to the file]' \
        '--device=[Add a host device to the container]' \
        '--dns=[Set custom dns servers]' \
        '--dns-search=[Set custom DNS search domains]' \
        '(-e,--env=)'{-e,--env=}'[Set environment variables]' \
        '--env-file=[Read in a file of environment variables]' \
        '--entrypoint=[Overwrite the default entrypoint of the image]' \
        '--expose=[Expose a port from the container without publishing it to your host]' \
        '(-h,--hostname=)'{-h,--hostname=}'[Container host name]' \
        '(-i,--interactive=)'{-i,--interactive=}'[Keep STDIN open even if not attached]' \
        '--ipc=[IPC namespace to use]' \
        '(-l,--label=)'{-l,--label=}'[Set meta data on a container]' \
        '--link=[Add link to another container (name:alias)]' \
        '--log-driver=[Logging driver for the container]' \
        '--lxc-conf=[Add custom LXC options]' \
        '--mac-address=[Container MAC address (e.g. 92:d0:c6:0a:29:33)]' \
        '(-m,--memory=)'{-m,--memory=}'[Memory limit (format: <number><optional unit>, where unit = b, k, m or g)]' \
        '--net=[Set the Network mode for the container]' \
        '--name=[Assign a name to the container]' \
        '--pid=[PID namespace to use]' \
        '(-p,--publish=)'{-p,--publish=}'[Publish a container''s port to the host (format: ip:hostPort:containerPort/protocol)]' \
        '--privileged=[Give extended privileges to this container]' \
        '--restart=[Restart policy to apply when a container exits]' \
        '--security-opt=[Security Options]' \
        '--sig-proxy=[Proxify all received signal to the process (even in non-tty mode)]' \
        '(-t,--tty=)'{-t,--tty=}'[Allocate a pseudo-tty]' \
        '(-u,--user=)'{-u,--user=}'[Username or UID]' \
        '--ulimit=[Ulimit options]' \
        '(-v,--volume=)'{-v,--volume=}'[Bind mount a volume (e.g. -v /host:/container or -v /container)]' \
        '--volumes-from=[Mount volumes from the specified container(s)]' \
        '(-w,--workdir=)'{-w,--workdir=}'[Working directory inside the container]'
    __docker_images
}

Ahmed Azaan's avatar
Ahmed Azaan committed
108
109
110
111
__diff() {
    __docker_containers
}

112
__events() {    
113
114
115
116
    _arguments \
        '--since=[Show previously created events and then stream.]'
}

Ahmed Azaan's avatar
Ahmed Azaan committed
117
118
119
120
121
__export() {
   __docker_containers
}

__history() {
122
123
124
    _arguments \
        '--no-trunc=[Don''t truncate output]' \
        '(-q,--quiet)'{-q,--quiet}'[Only show numeric IDs]'
Ahmed Azaan's avatar
Ahmed Azaan committed
125
126
127
128
129
    __docker_images
}

__images() {
    _arguments \
130
131
132
133
134
        '(-a,--all)'{-a,--all}'[Show all images (by default filter out the intermediate images used to build)]' \
        '--no-trunc[Don''t truncate output]' \
        '(-q,--quiet=)'{-q,--quiet=}'[Only show numeric IDs]' \
        '(-t,--tree=)'{-t,--tree=}'[Output graph in tree format]' \
        '(-v,--viz=)'{-v,--viz=}'[Output graph in graphviz format]'
Ahmed Azaan's avatar
Ahmed Azaan committed
135
136
137
138
139
140
141
142
143
144
145
146
147
    __docker_images
}

__import() {
    _arguments '*:files:_files'
}

__info() {
    # no arguments
}

__inspect() {
    __docker_images
148
    __docker_all_containers
Ahmed Azaan's avatar
Ahmed Azaan committed
149
150
151
}

__kill() {
152
153
    _arguments \
        '(-s,--signal=)'{-s,--signal=}'[KILL Signal]'
Ahmed Azaan's avatar
Ahmed Azaan committed
154
155
156
    __docker_containers
}

157
158
159
160
__load() {
    _arguments '*:files:_files'
}

Ahmed Azaan's avatar
Ahmed Azaan committed
161
162
__login() {
    _arguments \
163
164
165
        '(-e,--email=)'{-e,-email=}'[Email]' \
        '(-p,--password=)'{-p,-password=}'[Password]' \
        '(-u,--username=)'{-u,-username=}'[Username]'
Ahmed Azaan's avatar
Ahmed Azaan committed
166
167
168
}

__logs() {
169
170
    _arguments \
        '(-f,--follow)'{-f,-follow}'[Follow log output]'
Ahmed Azaan's avatar
Ahmed Azaan committed
171
172
173
174
175
176
177
178
179
180
181
182
183
    __docker_containers
}

__port() {
    __docker_containers
}

__top() {
    __docker_containers
}

__ps() {
    _arguments \
184
185
186
187
188
189
190
191
        '(-a,--all)'{-a,--all}'[Show all containers. Only running containers are shown by default.]' \
        '--before-id=[Show only container created before Id, include non-running ones.]' \
        '(-l,--latest)'{-l,--latest}'[Show only the latest created container, include non-running ones.]' \
        '-n=[Show n last created containers, include non-running ones. default=-1.]' \
        '--no-trunc[Don''t truncate output]' \
        '(-q,--quiet)'{-q,--quiet}'[Only display numeric IDs]' \
        '(-s,--size)'{-s,--size}'[Display sizes]' \
        '--since-id=[Show only containers created since Id, include non-running ones.]'
Ahmed Azaan's avatar
Ahmed Azaan committed
192
193
194
}

__pull() {
195
196
    _arguments \
        '(-t,--tag=)'{-t,--tag=}'[Download tagged image in repository]'
Ahmed Azaan's avatar
Ahmed Azaan committed
197
198
199
}

__push() {
200
    # no arguments
Ahmed Azaan's avatar
Ahmed Azaan committed
201
202
203
}

__restart() {
204
205
    _arguments \
        '(-t,--time=)'{-t,--time=}'[Number of seconds to try to stop for before killing the container. Once killed it will then be restarted. Default=10]'
Ahmed Azaan's avatar
Ahmed Azaan committed
206
207
208
209
    __docker_containers
}

__rm() {
210
211
212
213
    _arguments \
        '(-f,--force=)'{-f,--force=}'[Force removal of running container]' \
        '(-l,--link=)'{-l,--link=}'[Remove the specified link and not the underlying container]' \
        '(-v,--volumes=)'{-v,--volumes=}'[Remove the volumes associated to the container]'
214
    __docker_all_containers
Ahmed Azaan's avatar
Ahmed Azaan committed
215
216
217
}

__rmi() {
218
    _arguments \
219
        '(-f,--force=)'{-f,--force=}'[Force]'
Ahmed Azaan's avatar
Ahmed Azaan committed
220
221
222
223
224
    __docker_images
}

__run() {
    _arguments \
225
        '(-P,--publish-all=)'{-P,--publish-all=}'[Publish all exposed ports to the host interfaces]' \
UserTaken's avatar
UserTaken committed
226
227
228
229
        '(-a,--attach=)'{-a,--attach=}'[Attach to STDIN, STDOUT or STDERR]' \
        '--add-host=[Add a custom host-to-IP mapping]' \
        '--cap-add=[Add Linux capabilities]' \
        '--cap-drop=[Drop Linux capabilities]' \
UserTaken's avatar
UserTaken committed
230
231
        '--cpuset-cpus=[CPUs in which to allow execution (0-3, 0,1)]' \
        '(-c,--cpu-shares=)'{-c,--cpu-shares=}'[CPU shares (relative weight)]' \
232
        '--cidfile=[Write the container ID to the file]' \
UserTaken's avatar
UserTaken committed
233
234
        '(-d,--detach=)'{-d,--detach=}'[Run container in the background, print new container id]' \
        '--device=[Add a host device to the container]' \
235
        '--dns=[Set custom dns servers]' \
UserTaken's avatar
UserTaken committed
236
        '--dns-search=[Set custom DNS search domains]' \
237
        '(-e,--env=)'{-e,--env=}'[Set environment variables]' \
UserTaken's avatar
UserTaken committed
238
        '--env-file=[Read in a file of environment variables]' \
239
240
241
        '--entrypoint=[Overwrite the default entrypoint of the image]' \
        '--expose=[Expose a port from the container without publishing it to your host]' \
        '(-h,--hostname=)'{-h,--hostname=}'[Container host name]' \
UserTaken's avatar
UserTaken committed
242
243
244
        '(-i,--interactive=)'{-i,--interactive=}'[Keep STDIN open even if not attached]' \
        '--ipc=[IPC namespace to use]' \
        '(-l,--label=)'{-l,--label=}'[Set meta data on a container]' \
245
        '--link=[Add link to another container (name:alias)]' \
UserTaken's avatar
UserTaken committed
246
247
248
        '--log-driver=[Logging driver for the container]' \
        '--lxc-conf=[Add custom LXC options]' \
        '--mac-address=[Container MAC address (e.g. 92:d0:c6:0a:29:33)]' \
249
        '(-m,--memory=)'{-m,--memory=}'[Memory limit (format: <number><optional unit>, where unit = b, k, m or g)]' \
UserTaken's avatar
UserTaken committed
250
        '--net=[Set the Network mode for the container]' \
251
        '--name=[Assign a name to the container]' \
UserTaken's avatar
UserTaken committed
252
253
        '--pid=[PID namespace to use]' \
        '(-p,--publish=)'{-p,--publish=}'[Publish a container''s port to the host (format: ip:hostPort:containerPort/protocol)]' \
254
        '--privileged=[Give extended privileges to this container]' \
UserTaken's avatar
UserTaken committed
255
        '--restart=[Restart policy to apply when a container exits]' \
256
        '--rm=[Automatically remove the container when it exits (incompatible with -d)]' \
UserTaken's avatar
UserTaken committed
257
        '--security-opt=[Security Options]' \
258
259
260
        '--sig-proxy=[Proxify all received signal to the process (even in non-tty mode)]' \
        '(-t,--tty=)'{-t,--tty=}'[Allocate a pseudo-tty]' \
        '(-u,--user=)'{-u,--user=}'[Username or UID]' \
UserTaken's avatar
UserTaken committed
261
262
        '--ulimit=[Ulimit options]' \
        '(-v,--volume=)'{-v,--volume=}'[Bind mount a volume (e.g. -v /host:/container or -v /container)]' \
263
264
        '--volumes-from=[Mount volumes from the specified container(s)]' \
        '(-w,--workdir=)'{-w,--workdir=}'[Working directory inside the container]'
Ahmed Azaan's avatar
Ahmed Azaan committed
265
266
267
268
    __docker_images
}

__search() {
269
270
271
272
273
274
275
276
    _arguments \
        '--no-trunc=[Don''t truncate output]' \
        '-s,--stars=)'{-s,--stars=}'[Only displays with at least xxx stars]' \
        '-t,--trusted=)'{-t,--trusted=}'[Only show trusted builds]'
}

__save() {
    __docker_images
Ahmed Azaan's avatar
Ahmed Azaan committed
277
278
279
}

__start() {
280
    _arguments \
UserTaken's avatar
UserTaken committed
281
282
        '(-a,--attach=)'{-a,--attach=}'[Attach container''s STDOUT/STDERR and forward all signals to the process]' \
        '(-i,--interactive=)'{-i,--interactive=}'[Attach container''s STDIN]'
283
    __docker_all_containers
Ahmed Azaan's avatar
Ahmed Azaan committed
284
285
}

286
287
288
289
__stats() {
    __docker_containers
}

Ahmed Azaan's avatar
Ahmed Azaan committed
290
__stop() {
291
292
    _arguments \
        '(-t,--time=)'{-t,--time=}'[Number of seconds to wait for the container to stop before killing it.]'
Ahmed Azaan's avatar
Ahmed Azaan committed
293
294
295
296
    __docker_containers
}

__tag() {
297
298
    _arguments \
        '(-f,--force=)'{-f,--force=}'[Force]'
Ahmed Azaan's avatar
Ahmed Azaan committed
299
300
301
302
    __docker_images
}

__version() {
303
    # no arguments
Ahmed Azaan's avatar
Ahmed Azaan committed
304
305
306
}

__wait() {
Ahmed Azaan's avatar
Ahmed Azaan committed
307
    __docker_containers
Ahmed Azaan's avatar
Ahmed Azaan committed
308
309
}

310
311
312
313
314
315
316
317
__exec() {
    _arguments \
      '(-d,--detach=)'{-d,--detach=}'[Detached mode: run command in the background]' \
      '(-i,--interactive=)'{-i,--interactive=}'[Keep STDIN open even if not attached]' \
      '(-t,--tty=)'{-t,--tty=}'[Allocate a pseudo-TTY]'
    __docker_containers
}

Ahmed Azaan's avatar
Ahmed Azaan committed
318
319
320
321
322
323
324
325
# end commands ---------
# ----------------------

local -a _1st_arguments
_1st_arguments=(
    "attach":"Attach to a running container"
    "build":"Build a container from a Dockerfile"
    "commit":"Create a new image from a container's changes"
326
    "cp":"Copy files/folders from the containers filesystem to the host path"
UserTaken's avatar
UserTaken committed
327
    "create":"Create new container without running it"
Ahmed Azaan's avatar
Ahmed Azaan committed
328
    "diff":"Inspect changes on a container's filesystem"
329
    "events":"Get real time events from the server"
Ahmed Azaan's avatar
Ahmed Azaan committed
330
331
332
333
334
335
336
    "export":"Stream the contents of a container as a tar archive"
    "history":"Show the history of an image"
    "images":"List images"
    "import":"Create a new filesystem image from the contents of a tarball"
    "info":"Display system-wide information"
    "inspect":"Return low-level information on a container"
    "kill":"Kill a running container"
337
    "load":"Load an image from a tar archive"
Ahmed Azaan's avatar
Ahmed Azaan committed
338
339
340
341
342
343
344
345
346
347
    "login":"Register or Login to the docker registry server"
    "logs":"Fetch the logs of a container"
    "port":"Lookup the public-facing port which is NAT-ed to PRIVATE_PORT"
    "ps":"List containers"
    "pull":"Pull an image or a repository from the docker registry server"
    "push":"Push an image or a repository to the docker registry server"
    "restart":"Restart a running container"
    "rm":"Remove one or more containers"
    "rmi":"Remove one or more images"
    "run":"Run a command in a new container"
348
    "save":"Save an image to a tar archive"
Ahmed Azaan's avatar
Ahmed Azaan committed
349
350
    "search":"Search for an image in the docker index"
    "start":"Start a stopped container"
351
    "stats":"Display a live stream of one or more containers' resource usage statistics"
Ahmed Azaan's avatar
Ahmed Azaan committed
352
353
    "stop":"Stop a running container"
    "tag":"Tag an image into a repository"
354
    "top":"Lookup the running processes of a container"
Ahmed Azaan's avatar
Ahmed Azaan committed
355
356
    "version":"Show the docker version information"
    "wait":"Block until a container stops, then print its exit code"
357
    "exec":"Run a task inside a running container"
Ahmed Azaan's avatar
Ahmed Azaan committed
358
359
360
361
362
363
364
365
366
367
368
369
)

_arguments '*:: :->command'

if (( CURRENT == 1 )); then
    _describe -t commands "docker command" _1st_arguments
    return
fi

local -a _command_args
case "$words[1]" in
    attach)
370
       __attach ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
371
372
373
374
    build)
        __build ;;
    commit)
        __commit ;;
375
376
    cp)
        __cp ;;
UserTaken's avatar
UserTaken committed
377
378
    create)
        __create ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
379
380
    diff)
        __diff ;;
381
382
    events)
        __events ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
383
384
385
386
387
388
389
390
391
392
393
394
395
396
    export)
        __export ;;
    history)
        __history ;;
    images)
        __images ;;
    import)
        __import ;;
    info)
        __info ;;
    inspect)
        __inspect ;;
    kill)
        __kill ;;
397
398
    load)
        __load ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
    login)
        __login ;;
    logs)
        __logs ;;
    port)
        __port ;;
    ps)
        __ps ;;
    pull)
        __pull ;;
    push)
        __push ;;
    restart)
        __restart ;;
    rm)
        __rm ;;
    rmi)
        __rmi ;;
    run)
        __run ;;
419
420
    save)
        __save ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
421
422
    search)
        __search ;;
423
424
    stats)
        __stats ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
425
426
427
428
429
430
    start)
        __start ;;
    stop)
        __stop ;;
    tag)
        __tag ;;
431
432
    top)
        __top ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
433
434
435
436
    version)
        __version ;;
    wait)
        __wait ;;
437
438
    exec)
        __exec ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
439
esac