docker-compose 6.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312
  1. #!bash
  2. #
  3. # bash completion for docker-compose
  4. #
  5. # This work is based on the completion for the docker command.
  6. #
  7. # This script provides completion of:
  8. # - commands and their options
  9. # - service names
  10. # - filepaths
  11. #
  12. # To enable the completions either:
  13. # - place this file in /etc/bash_completion.d
  14. # or
  15. # - copy this file to e.g. ~/.docker-compose-completion.sh and add the line
  16. # below to your .bashrc after bash completion features are loaded
  17. # . ~/.docker-compose-completion.sh
  18. # Extracts all service names from docker-compose.yml.
  19. ___docker-compose_all_services_in_compose_file() {
  20. awk -F: '/^[a-zA-Z0-9]/{print $1}' "${compose_file:-docker-compose.yml}"
  21. }
  22. # All services, even those without an existing container
  23. __docker-compose_services_all() {
  24. COMPREPLY=( $(compgen -W "$(___docker-compose_all_services_in_compose_file)" -- "$cur") )
  25. }
  26. # All services that have an entry with the given key in their docker-compose.yml section
  27. ___docker-compose_services_with_key() {
  28. # flatten sections to one line, then filter lines containing the key and return section name.
  29. awk '/^[a-zA-Z0-9]/{printf "\n"};{printf $0;next;}' "${compose_file:-docker-compose.yml}" | awk -F: -v key=": +$1:" '$0 ~ key {print $1}'
  30. }
  31. # All services that are defined by a Dockerfile reference
  32. __docker-compose_services_from_build() {
  33. COMPREPLY=( $(compgen -W "$(___docker-compose_services_with_key build)" -- "$cur") )
  34. }
  35. # All services that are defined by an image
  36. __docker-compose_services_from_image() {
  37. COMPREPLY=( $(compgen -W "$(___docker-compose_services_with_key image)" -- "$cur") )
  38. }
  39. # The services for which containers have been created, optionally filtered
  40. # by a boolean expression passed in as argument.
  41. __docker-compose_services_with() {
  42. local containers names
  43. containers="$(docker-compose 2>/dev/null ${compose_file:+-f $compose_file} ${compose_project:+-p $compose_project} ps -q)"
  44. names=( $(docker 2>/dev/null inspect --format "{{if ${1:-true}}} {{ .Name }} {{end}}" $containers) )
  45. names=( ${names[@]%_*} ) # strip trailing numbers
  46. names=( ${names[@]#*_} ) # strip project name
  47. COMPREPLY=( $(compgen -W "${names[*]}" -- "$cur") )
  48. }
  49. # The services for which at least one running container exists
  50. __docker-compose_services_running() {
  51. __docker-compose_services_with '.State.Running'
  52. }
  53. # The services for which at least one stopped container exists
  54. __docker-compose_services_stopped() {
  55. __docker-compose_services_with 'not .State.Running'
  56. }
  57. _docker-compose_build() {
  58. case "$cur" in
  59. -*)
  60. COMPREPLY=( $( compgen -W "--no-cache" -- "$cur" ) )
  61. ;;
  62. *)
  63. __docker-compose_services_from_build
  64. ;;
  65. esac
  66. }
  67. _docker-compose_docker-compose() {
  68. case "$prev" in
  69. --file|-f)
  70. _filedir
  71. return
  72. ;;
  73. --project-name|-p)
  74. return
  75. ;;
  76. esac
  77. case "$cur" in
  78. -*)
  79. COMPREPLY=( $( compgen -W "--help -h --verbose --version --file -f --project-name -p" -- "$cur" ) )
  80. ;;
  81. *)
  82. COMPREPLY=( $( compgen -W "${commands[*]}" -- "$cur" ) )
  83. ;;
  84. esac
  85. }
  86. _docker-compose_help() {
  87. COMPREPLY=( $( compgen -W "${commands[*]}" -- "$cur" ) )
  88. }
  89. _docker-compose_kill() {
  90. case "$prev" in
  91. -s)
  92. COMPREPLY=( $( compgen -W "SIGHUP SIGINT SIGKILL SIGUSR1 SIGUSR2" -- "$(echo $cur | tr '[:lower:]' '[:upper:]')" ) )
  93. return
  94. ;;
  95. esac
  96. case "$cur" in
  97. -*)
  98. COMPREPLY=( $( compgen -W "-s" -- "$cur" ) )
  99. ;;
  100. *)
  101. __docker-compose_services_running
  102. ;;
  103. esac
  104. }
  105. _docker-compose_logs() {
  106. case "$cur" in
  107. -*)
  108. COMPREPLY=( $( compgen -W "--no-color" -- "$cur" ) )
  109. ;;
  110. *)
  111. __docker-compose_services_all
  112. ;;
  113. esac
  114. }
  115. _docker-compose_port() {
  116. case "$prev" in
  117. --protocol)
  118. COMPREPLY=( $( compgen -W "tcp udp" -- "$cur" ) )
  119. return;
  120. ;;
  121. --index)
  122. return;
  123. ;;
  124. esac
  125. case "$cur" in
  126. -*)
  127. COMPREPLY=( $( compgen -W "--protocol --index" -- "$cur" ) )
  128. ;;
  129. *)
  130. __docker-compose_services_all
  131. ;;
  132. esac
  133. }
  134. _docker-compose_ps() {
  135. case "$cur" in
  136. -*)
  137. COMPREPLY=( $( compgen -W "-q" -- "$cur" ) )
  138. ;;
  139. *)
  140. __docker-compose_services_all
  141. ;;
  142. esac
  143. }
  144. _docker-compose_pull() {
  145. case "$cur" in
  146. -*)
  147. COMPREPLY=( $( compgen -W "--allow-insecure-ssl" -- "$cur" ) )
  148. ;;
  149. *)
  150. __docker-compose_services_from_image
  151. ;;
  152. esac
  153. }
  154. _docker-compose_restart() {
  155. __docker-compose_services_running
  156. }
  157. _docker-compose_rm() {
  158. case "$cur" in
  159. -*)
  160. COMPREPLY=( $( compgen -W "--force -v" -- "$cur" ) )
  161. ;;
  162. *)
  163. __docker-compose_services_stopped
  164. ;;
  165. esac
  166. }
  167. _docker-compose_run() {
  168. case "$prev" in
  169. -e)
  170. COMPREPLY=( $( compgen -e -- "$cur" ) )
  171. compopt -o nospace
  172. return
  173. ;;
  174. --entrypoint)
  175. return
  176. ;;
  177. esac
  178. case "$cur" in
  179. -*)
  180. COMPREPLY=( $( compgen -W "--allow-insecure-ssl -d --entrypoint -e --no-deps --rm -T" -- "$cur" ) )
  181. ;;
  182. *)
  183. __docker-compose_services_all
  184. ;;
  185. esac
  186. }
  187. _docker-compose_scale() {
  188. case "$prev" in
  189. =)
  190. COMPREPLY=("$cur")
  191. ;;
  192. *)
  193. COMPREPLY=( $(compgen -S "=" -W "$(___docker-compose_all_services_in_compose_file)" -- "$cur") )
  194. compopt -o nospace
  195. ;;
  196. esac
  197. }
  198. _docker-compose_start() {
  199. __docker-compose_services_stopped
  200. }
  201. _docker-compose_stop() {
  202. __docker-compose_services_running
  203. }
  204. _docker-compose_up() {
  205. case "$cur" in
  206. -*)
  207. COMPREPLY=( $( compgen -W "--allow-insecure-ssl -d --no-build --no-color --no-deps --no-recreate" -- "$cur" ) )
  208. ;;
  209. *)
  210. __docker-compose_services_all
  211. ;;
  212. esac
  213. }
  214. _docker-compose() {
  215. local commands=(
  216. build
  217. help
  218. kill
  219. logs
  220. port
  221. ps
  222. pull
  223. restart
  224. rm
  225. run
  226. scale
  227. start
  228. stop
  229. up
  230. )
  231. COMPREPLY=()
  232. local cur prev words cword
  233. _get_comp_words_by_ref -n : cur prev words cword
  234. # search subcommand and invoke its handler.
  235. # special treatment of some top-level options
  236. local command='docker-compose'
  237. local counter=1
  238. local compose_file compose_project
  239. while [ $counter -lt $cword ]; do
  240. case "${words[$counter]}" in
  241. -f|--file)
  242. (( counter++ ))
  243. compose_file="${words[$counter]}"
  244. ;;
  245. -p|--project-name)
  246. (( counter++ ))
  247. compose_project="${words[$counter]}"
  248. ;;
  249. -*)
  250. ;;
  251. *)
  252. command="${words[$counter]}"
  253. break
  254. ;;
  255. esac
  256. (( counter++ ))
  257. done
  258. local completions_func=_docker-compose_${command}
  259. declare -F $completions_func >/dev/null && $completions_func
  260. return 0
  261. }
  262. complete -F _docker-compose docker-compose