_docker 10.8 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")]"}'))
Ahmed Azaan's avatar
Ahmed Azaan committed
15
16
17
18
19
20
21
22
23
24
25
26
27
28
    _describe 'containers' cont_cmd
}

# 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() {
29
30
31
    _arguments \
        '--no-stdin[Do not attach stdin]' \
        '--sig-proxy[Proxify all received signal to the process (even in non-tty mode)]'
Ahmed Azaan's avatar
Ahmed Azaan committed
32
33
34
35
36
    __docker_containers
}

__build() {
    _arguments \
37
38
39
40
        '--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
41
        '*:files:_files'
Ahmed Azaan's avatar
Ahmed Azaan committed
42
43
44
45
}

__commit() {
    _arguments \
46
47
48
49
50
51
52
        '(-a,--author=)'{-a,--author=}'[Author (eg. "John Hannibal Smith <hannibal@a-team.com>"]' \
        '(-m,--message=)'{-m,--message=}'[Commit message]' \
        '--run=[Config automatically applied when the image is run.]'
    __docker_containers
}

__cp() {
Ahmed Azaan's avatar
Ahmed Azaan committed
53
54
55
56
57
58
59
    __docker_containers
}

__diff() {
    __docker_containers
}

60
61
62
63
64
__events() {
    _arguments \
        '--since=[Show previously created events and then stream.]'
}

Ahmed Azaan's avatar
Ahmed Azaan committed
65
66
67
68
69
__export() {
   __docker_containers
}

__history() {
70
71
72
    _arguments \
        '--no-trunc=[Don''t truncate output]' \
        '(-q,--quiet)'{-q,--quiet}'[Only show numeric IDs]'
Ahmed Azaan's avatar
Ahmed Azaan committed
73
74
75
76
77
    __docker_images
}

__images() {
    _arguments \
78
79
80
81
82
        '(-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
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
    __docker_images
}

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

__info() {
    # no arguments
}

__insert() {
    __docker_images
    _arguments '*:files:_files'
}

__inspect() {
    __docker_images
    __docker_containers
}

__kill() {
    __docker_containers
}

108
109
110
111
__load() {
    _arguments '*:files:_files'
}

Ahmed Azaan's avatar
Ahmed Azaan committed
112
113
__login() {
    _arguments \
114
115
116
        '(-e,--email=)'{-e,-email=}'[Email]' \
        '(-p,--password=)'{-p,-password=}'[Password]' \
        '(-u,--username=)'{-u,-username=}'[Username]'
Ahmed Azaan's avatar
Ahmed Azaan committed
117
118
119
}

__logs() {
120
121
    _arguments \
        '(-f,--follow)'{-f,-follow}'[Follow log output]'
Ahmed Azaan's avatar
Ahmed Azaan committed
122
123
124
125
126
127
128
129
130
131
132
133
134
    __docker_containers
}

__port() {
    __docker_containers
}

__top() {
    __docker_containers
}

__ps() {
    _arguments \
135
136
137
138
139
140
141
142
        '(-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
143
144
145
}

__pull() {
146
147
    _arguments \
        '(-t,--tag=)'{-t,--tag=}'[Download tagged image in repository]'
Ahmed Azaan's avatar
Ahmed Azaan committed
148
149
150
}

__push() {
151
    # no arguments
Ahmed Azaan's avatar
Ahmed Azaan committed
152
153
154
}

__restart() {
155
156
    _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
157
158
159
160
    __docker_containers
}

__rm() {
161
162
163
164
    _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]'
Ahmed Azaan's avatar
Ahmed Azaan committed
165
166
167
168
    __docker_containers
}

__rmi() {
169
    _arguments \
170
        '(-f,--force=)'{-f,--force=}'[Force]'
Ahmed Azaan's avatar
Ahmed Azaan committed
171
172
173
174
175
    __docker_images
}

__run() {
    _arguments \
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
        '(-P,--publish-all=)'{-P,--publish-all=}'[Publish all exposed ports to the host interfaces]' \
        '(-a,--attach=)'{-a,--attach=}'[Attach to stdin, stdout or stderr.]' \
        '(-c,--cpu-shares=)'{-c,--cpu-shares=}': CPU shares (relative weight)]' \
        '--cidfile=[Write the container ID to the file]' \
        '(-d,--detach=)'{-d,--detach=}'[Detached mode: Run container in the background, print new container id]' \
        '--dns=[Set custom dns servers]' \
        '(-e,--env=)'{-e,--env=}'[Set 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]' \
        '--link=[Add link to another container (name:alias)]' \
        '--lxc-conf=[Add custom lxc options -lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"]' \
        '(-m,--memory=)'{-m,--memory=}'[Memory limit (format: <number><optional unit>, where unit = b, k, m or g)]' \
        '(-n,--networking=)'{-n,--networking=}'[Enable networking for this container]' \
        '--name=[Assign a name to the container]' \
        '(-p,--publish=)'{-p,--publish=}'[Publish a container''s port to the host (format: ip:hostPort:containerPort | ip::containerPort | hostPort:containerPort) (use "docker port" to see the actual mapping)]' \
        '--privileged=[Give extended privileges to this container]' \
        '--rm=[Automatically remove the container when it exits (incompatible with -d)]' \
        '--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]' \
        '(-v,--volume=)'{-v,--volume=}'[Bind mount a volume (e.g. from the host: -v /host:/container, from docker: -v /container)]' \
        '--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
201
202
203
204
    __docker_images
}

__search() {
205
206
207
208
209
210
211
212
    _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
213
214
215
}

__start() {
216
217
    _arguments \
        '(-a,--attach=)'{-a,--attach=}'[Attach container''s stdout/stderr and forward all signals to the process]' \
Josh Comer's avatar
Josh Comer committed
218
        '(-i,--interactive=)'{-i,--interactive=}'[Attach container''s stdin]'
Ahmed Azaan's avatar
Ahmed Azaan committed
219
    __docker_containers
Ahmed Azaan's avatar
Ahmed Azaan committed
220
221
}

222
223
224
225
__stats() {
    __docker_containers
}

Ahmed Azaan's avatar
Ahmed Azaan committed
226
__stop() {
227
228
    _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
229
230
231
232
    __docker_containers
}

__tag() {
233
234
    _arguments \
        '(-f,--force=)'{-f,--force=}'[Force]'
Ahmed Azaan's avatar
Ahmed Azaan committed
235
236
237
238
    __docker_images
}

__version() {
239
    # no arguments
Ahmed Azaan's avatar
Ahmed Azaan committed
240
241
242
}

__wait() {
Ahmed Azaan's avatar
Ahmed Azaan committed
243
    __docker_containers
Ahmed Azaan's avatar
Ahmed Azaan committed
244
245
}

246
247
248
249
250
251
252
253
__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
254
255
256
257
258
259
260
261
# 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"
262
    "cp":"Copy files/folders from the containers filesystem to the host path"
Ahmed Azaan's avatar
Ahmed Azaan committed
263
    "diff":"Inspect changes on a container's filesystem"
264
    "events":"Get real time events from the server"
Ahmed Azaan's avatar
Ahmed Azaan committed
265
266
267
268
269
270
271
272
    "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"
    "insert":"Insert a file in an image"
    "inspect":"Return low-level information on a container"
    "kill":"Kill a running container"
273
    "load":"Load an image from a tar archive"
Ahmed Azaan's avatar
Ahmed Azaan committed
274
275
276
277
278
279
280
281
282
283
    "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"
284
    "save":"Save an image to a tar archive"
Ahmed Azaan's avatar
Ahmed Azaan committed
285
286
    "search":"Search for an image in the docker index"
    "start":"Start a stopped container"
287
    "stats":"Display a live stream of one or more containers' resource usage statistics"
Ahmed Azaan's avatar
Ahmed Azaan committed
288
289
    "stop":"Stop a running container"
    "tag":"Tag an image into a repository"
290
    "top":"Lookup the running processes of a container"
Ahmed Azaan's avatar
Ahmed Azaan committed
291
292
    "version":"Show the docker version information"
    "wait":"Block until a container stops, then print its exit code"
293
    "exec":"Run a task inside a running container"
Ahmed Azaan's avatar
Ahmed Azaan committed
294
295
296
297
298
299
300
301
302
303
304
305
)

_arguments '*:: :->command'

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

local -a _command_args
case "$words[1]" in
    attach)
306
       __attach ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
307
308
309
310
    build)
        __build ;;
    commit)
        __commit ;;
311
312
    cp)
        __cp ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
313
314
    diff)
        __diff ;;
315
316
    events)
        __events ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
    export)
        __export ;;
    history)
        __history ;;
    images)
        __images ;;
    import)
        __import ;;
    info)
        __info ;;
    insert)
        __insert ;;
    inspect)
        __inspect ;;
    kill)
        __kill ;;
333
334
    load)
        __load ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
    login)
        __login ;;
    logs)
        __logs ;;
    port)
        __port ;;
    ps)
        __ps ;;
    pull)
        __pull ;;
    push)
        __push ;;
    restart)
        __restart ;;
    rm)
        __rm ;;
    rmi)
        __rmi ;;
    run)
        __run ;;
355
356
    save)
        __save ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
357
358
    search)
        __search ;;
359
360
    stats)
        __stats ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
361
362
363
364
365
366
    start)
        __start ;;
    stop)
        __stop ;;
    tag)
        __tag ;;
367
368
    top)
        __top ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
369
370
371
372
    version)
        __version ;;
    wait)
        __wait ;;
373
374
    exec)
        __exec ;;
Ahmed Azaan's avatar
Ahmed Azaan committed
375
esac