cli.rst 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894
  1. :title: Command Line Interface
  2. :description: Docker's CLI command description and usage
  3. :keywords: Docker, Docker documentation, CLI, command line
  4. .. _cli:
  5. Command Line Help
  6. -----------------
  7. To list available commands, either run ``docker`` with no parameters or execute
  8. ``docker help``::
  9. $ sudo docker
  10. Usage: docker [OPTIONS] COMMAND [arg...]
  11. -H=[unix:///var/run/docker.sock]: tcp://host:port to bind/connect to or unix://path/to/socket to use
  12. A self-sufficient runtime for linux containers.
  13. ...
  14. .. _cli_attach:
  15. ``attach``
  16. ----------
  17. ::
  18. Usage: docker attach CONTAINER
  19. Attach to a running container.
  20. -nostdin=false: Do not attach stdin
  21. -sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
  22. You can detach from the container again (and leave it running) with
  23. ``CTRL-c`` (for a quiet exit) or ``CTRL-\`` to get a stacktrace of
  24. the Docker client when it quits.
  25. To stop a container, use ``docker stop``
  26. To kill the container, use ``docker kill``
  27. .. _cli_attach_examples:
  28. Examples:
  29. ~~~~~~~~~
  30. .. code-block:: bash
  31. $ ID=$(sudo docker run -d ubuntu /usr/bin/top -b)
  32. $ sudo docker attach $ID
  33. top - 02:05:52 up 3:05, 0 users, load average: 0.01, 0.02, 0.05
  34. Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie
  35. Cpu(s): 0.1%us, 0.2%sy, 0.0%ni, 99.7%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
  36. Mem: 373572k total, 355560k used, 18012k free, 27872k buffers
  37. Swap: 786428k total, 0k used, 786428k free, 221740k cached
  38. PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
  39. 1 root 20 0 17200 1116 912 R 0 0.3 0:00.03 top
  40. top - 02:05:55 up 3:05, 0 users, load average: 0.01, 0.02, 0.05
  41. Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie
  42. Cpu(s): 0.0%us, 0.2%sy, 0.0%ni, 99.8%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
  43. Mem: 373572k total, 355244k used, 18328k free, 27872k buffers
  44. Swap: 786428k total, 0k used, 786428k free, 221776k cached
  45. PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
  46. 1 root 20 0 17208 1144 932 R 0 0.3 0:00.03 top
  47. top - 02:05:58 up 3:06, 0 users, load average: 0.01, 0.02, 0.05
  48. Tasks: 1 total, 1 running, 0 sleeping, 0 stopped, 0 zombie
  49. Cpu(s): 0.2%us, 0.3%sy, 0.0%ni, 99.5%id, 0.0%wa, 0.0%hi, 0.0%si, 0.0%st
  50. Mem: 373572k total, 355780k used, 17792k free, 27880k buffers
  51. Swap: 786428k total, 0k used, 786428k free, 221776k cached
  52. PID USER PR NI VIRT RES SHR S %CPU %MEM TIME+ COMMAND
  53. 1 root 20 0 17208 1144 932 R 0 0.3 0:00.03 top
  54. ^C$
  55. $ sudo docker stop $ID
  56. .. _cli_build:
  57. ``build``
  58. ---------
  59. ::
  60. Usage: docker build [OPTIONS] PATH | URL | -
  61. Build a new container image from the source code at PATH
  62. -t="": Repository name (and optionally a tag) to be applied to the resulting image in case of success.
  63. -q=false: Suppress verbose build output.
  64. -no-cache: Do not use the cache when building the image.
  65. -rm: Remove intermediate containers after a successful build
  66. When a single Dockerfile is given as URL, then no context is set. When a git repository is set as URL, the repository is used as context
  67. .. _cli_build_examples:
  68. Examples:
  69. ~~~~~~~~~
  70. .. code-block:: bash
  71. sudo docker build .
  72. This will read the ``Dockerfile`` from the current directory. It will
  73. also send any other files and directories found in the current
  74. directory to the ``docker`` daemon.
  75. The contents of this directory would be used by ``ADD`` commands found
  76. within the ``Dockerfile``. This will send a lot of data to the
  77. ``docker`` daemon if the current directory contains a lot of data. If
  78. the absolute path is provided instead of ``.`` then only the files and
  79. directories required by the ADD commands from the ``Dockerfile`` will be
  80. added to the context and transferred to the ``docker`` daemon.
  81. .. code-block:: bash
  82. sudo docker build -t vieux/apache:2.0 .
  83. This will build like the previous example, but it will then tag the
  84. resulting image. The repository name will be ``vieux/apache`` and the
  85. tag will be ``2.0``
  86. .. code-block:: bash
  87. sudo docker build - < Dockerfile
  88. This will read a ``Dockerfile`` from *stdin* without context. Due to
  89. the lack of a context, no contents of any local directory will be sent
  90. to the ``docker`` daemon. ``ADD`` doesn't work when running in this
  91. mode because the absence of the context provides no source files to
  92. copy to the container.
  93. .. code-block:: bash
  94. sudo docker build github.com/creack/docker-firefox
  95. This will clone the Github repository and use it as context. The
  96. ``Dockerfile`` at the root of the repository is used as
  97. ``Dockerfile``. Note that you can specify an arbitrary git repository
  98. by using the ``git://`` schema.
  99. .. _cli_commit:
  100. ``commit``
  101. ----------
  102. ::
  103. Usage: docker commit [OPTIONS] CONTAINER [REPOSITORY[:TAG]]
  104. Create a new image from a container's changes
  105. -m="": Commit message
  106. -author="": Author (eg. "John Hannibal Smith <hannibal@a-team.com>"
  107. -run="": Configuration to be applied when the image is launched with `docker run`.
  108. (ex: '{"Cmd": ["cat", "/world"], "PortSpecs": ["22"]}')
  109. Simple commit of an existing container
  110. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  111. .. code-block:: bash
  112. $ docker ps
  113. ID IMAGE COMMAND CREATED STATUS PORTS
  114. c3f279d17e0a ubuntu:12.04 /bin/bash 7 days ago Up 25 hours
  115. 197387f1b436 ubuntu:12.04 /bin/bash 7 days ago Up 25 hours
  116. $ docker commit c3f279d17e0a SvenDowideit/testimage:version3
  117. f5283438590d
  118. $ docker images | head
  119. REPOSITORY TAG ID CREATED SIZE
  120. SvenDowideit/testimage version3 f5283438590d 16 seconds ago 204.2 MB (virtual 335.7 MB)
  121. S
  122. Full -run example
  123. .................
  124. (multiline is ok within a single quote ``'``)
  125. ::
  126. $ sudo docker commit -run='
  127. {
  128. "Entrypoint" : null,
  129. "Privileged" : false,
  130. "User" : "",
  131. "VolumesFrom" : "",
  132. "Cmd" : ["cat", "-e", "/etc/resolv.conf"],
  133. "Dns" : ["8.8.8.8", "8.8.4.4"],
  134. "MemorySwap" : 0,
  135. "AttachStdin" : false,
  136. "AttachStderr" : false,
  137. "CpuShares" : 0,
  138. "OpenStdin" : false,
  139. "Volumes" : null,
  140. "Hostname" : "122612f45831",
  141. "PortSpecs" : ["22", "80", "443"],
  142. "Image" : "b750fe79269d2ec9a3c593ef05b4332b1d1a02a62b4accb2c21d589ff2f5f2dc",
  143. "Tty" : false,
  144. "Env" : [
  145. "HOME=/",
  146. "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"
  147. ],
  148. "StdinOnce" : false,
  149. "Domainname" : "",
  150. "WorkingDir" : "/",
  151. "NetworkDisabled" : false,
  152. "Memory" : 0,
  153. "AttachStdout" : false
  154. }' $CONTAINER_ID
  155. .. _cli_cp:
  156. ``cp``
  157. ------
  158. ::
  159. Usage: docker cp CONTAINER:RESOURCE HOSTPATH
  160. Copy files/folders from the containers filesystem to the host
  161. path. Paths are relative to the root of the filesystem.
  162. .. _cli_diff:
  163. ``diff``
  164. --------
  165. ::
  166. Usage: docker diff CONTAINER [OPTIONS]
  167. Inspect changes on a container's filesystem
  168. .. _cli_events:
  169. ``events``
  170. ----------
  171. ::
  172. Usage: docker events
  173. Get real time events from the server
  174. -since="": Show previously created events and then stream.
  175. (either seconds since epoch, or date string as below)
  176. .. _cli_events_example:
  177. Examples
  178. ~~~~~~~~
  179. You'll need two shells for this example.
  180. Shell 1: Listening for events
  181. .............................
  182. .. code-block:: bash
  183. $ sudo docker events
  184. Shell 2: Start and Stop a Container
  185. ...................................
  186. .. code-block:: bash
  187. $ sudo docker start 4386fb97867d
  188. $ sudo docker stop 4386fb97867d
  189. Shell 1: (Again .. now showing events)
  190. ......................................
  191. .. code-block:: bash
  192. [2013-09-03 15:49:26 +0200 CEST] 4386fb97867d: (from 12de384bfb10) start
  193. [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die
  194. [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop
  195. Show events in the past from a specified time
  196. .............................................
  197. .. code-block:: bash
  198. $ sudo docker events -since 1378216169
  199. [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die
  200. [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop
  201. $ sudo docker events -since '2013-09-03'
  202. [2013-09-03 15:49:26 +0200 CEST] 4386fb97867d: (from 12de384bfb10) start
  203. [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die
  204. [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop
  205. $ sudo docker events -since '2013-09-03 15:49:29 +0200 CEST'
  206. [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) die
  207. [2013-09-03 15:49:29 +0200 CEST] 4386fb97867d: (from 12de384bfb10) stop
  208. .. _cli_export:
  209. ``export``
  210. ----------
  211. ::
  212. Usage: docker export CONTAINER
  213. Export the contents of a filesystem as a tar archive
  214. .. _cli_history:
  215. ``history``
  216. -----------
  217. ::
  218. Usage: docker history [OPTIONS] IMAGE
  219. Show the history of an image
  220. -notrunc=false: Don't truncate output
  221. -q=false: only show numeric IDs
  222. .. _cli_images:
  223. ``images``
  224. ----------
  225. ::
  226. Usage: docker images [OPTIONS] [NAME]
  227. List images
  228. -a=false: show all images (by default filter out the intermediate images used to build)
  229. -notrunc=false: Don't truncate output
  230. -q=false: only show numeric IDs
  231. -tree=false: output graph in tree format
  232. -viz=false: output graph in graphviz format
  233. Listing the most recently created images
  234. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  235. .. code-block:: bash
  236. $ sudo docker images | head
  237. REPOSITORY TAG IMAGE ID CREATED SIZE
  238. <none> <none> 77af4d6b9913 19 hours ago 30.53 MB (virtual 1.089 GB)
  239. committest latest b6fa739cedf5 19 hours ago 30.53 MB (virtual 1.089 GB)
  240. <none> <none> 78a85c484f71 19 hours ago 30.53 MB (virtual 1.089 GB)
  241. docker latest 30557a29d5ab 20 hours ago 30.53 MB (virtual 1.089 GB)
  242. <none> <none> 0124422dd9f9 20 hours ago 30.53 MB (virtual 1.089 GB)
  243. <none> <none> 18ad6fad3402 22 hours ago 23.68 MB (virtual 1.082 GB)
  244. <none> <none> f9f1e26352f0 23 hours ago 30.46 MB (virtual 1.089 GB)
  245. tryout latest 2629d1fa0b81 23 hours ago 16.4 kB (virtual 131.5 MB)
  246. <none> <none> 5ed6274db6ce 24 hours ago 30.44 MB (virtual 1.089 GB)
  247. Listing the full length image IDs
  248. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  249. .. code-block:: bash
  250. $ sudo docker images -notrunc | head
  251. REPOSITORY TAG IMAGE ID CREATED SIZE
  252. <none> <none> 77af4d6b9913e693e8d0b4b294fa62ade6054e6b2f1ffb617ac955dd63fb0182 19 hours ago 30.53 MB (virtual 1.089 GB)
  253. committest latest b6fa739cedf5ea12a620a439402b6004d057da800f91c7524b5086a5e4749c9f 19 hours ago 30.53 MB (virtual 1.089 GB)
  254. <none> <none> 78a85c484f71509adeaace20e72e941f6bdd2b25b4c75da8693efd9f61a37921 19 hours ago 30.53 MB (virtual 1.089 GB)
  255. docker latest 30557a29d5abc51e5f1d5b472e79b7e296f595abcf19fe6b9199dbbc809c6ff4 20 hours ago 30.53 MB (virtual 1.089 GB)
  256. <none> <none> 0124422dd9f9cf7ef15c0617cda3931ee68346455441d66ab8bdc5b05e9fdce5 20 hours ago 30.53 MB (virtual 1.089 GB)
  257. <none> <none> 18ad6fad340262ac2a636efd98a6d1f0ea775ae3d45240d3418466495a19a81b 22 hours ago 23.68 MB (virtual 1.082 GB)
  258. <none> <none> f9f1e26352f0a3ba6a0ff68167559f64f3e21ff7ada60366e2d44a04befd1d3a 23 hours ago 30.46 MB (virtual 1.089 GB)
  259. tryout latest 2629d1fa0b81b222fca63371ca16cbf6a0772d07759ff80e8d1369b926940074 23 hours ago 16.4 kB (virtual 131.5 MB)
  260. <none> <none> 5ed6274db6ceb2397844896966ea239290555e74ef307030ebb01ff91b1914df 24 hours ago 30.44 MB (virtual 1.089 GB)
  261. Displaying images visually
  262. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  263. .. code-block:: bash
  264. $ sudo docker images -viz | dot -Tpng -o docker.png
  265. .. image:: docker_images.gif
  266. :alt: Example inheritance graph of Docker images.
  267. Displaying image hierarchy
  268. ~~~~~~~~~~~~~~~~~~~~~~~~~~
  269. .. code-block:: bash
  270. $ sudo docker images -tree
  271. |─8dbd9e392a96 Size: 131.5 MB (virtual 131.5 MB) Tags: ubuntu:12.04,ubuntu:latest,ubuntu:precise
  272. └─27cf78414709 Size: 180.1 MB (virtual 180.1 MB)
  273. └─b750fe79269d Size: 24.65 kB (virtual 180.1 MB) Tags: ubuntu:12.10,ubuntu:quantal
  274. |─f98de3b610d5 Size: 12.29 kB (virtual 180.1 MB)
  275. | └─7da80deb7dbf Size: 16.38 kB (virtual 180.1 MB)
  276. | └─65ed2fee0a34 Size: 20.66 kB (virtual 180.2 MB)
  277. | └─a2b9ea53dddc Size: 819.7 MB (virtual 999.8 MB)
  278. | └─a29b932eaba8 Size: 28.67 kB (virtual 999.9 MB)
  279. | └─e270a44f124d Size: 12.29 kB (virtual 999.9 MB) Tags: progrium/buildstep:latest
  280. └─17e74ac162d8 Size: 53.93 kB (virtual 180.2 MB)
  281. └─339a3f56b760 Size: 24.65 kB (virtual 180.2 MB)
  282. └─904fcc40e34d Size: 96.7 MB (virtual 276.9 MB)
  283. └─b1b0235328dd Size: 363.3 MB (virtual 640.2 MB)
  284. └─7cb05d1acb3b Size: 20.48 kB (virtual 640.2 MB)
  285. └─47bf6f34832d Size: 20.48 kB (virtual 640.2 MB)
  286. └─f165104e82ed Size: 12.29 kB (virtual 640.2 MB)
  287. └─d9cf85a47b7e Size: 1.911 MB (virtual 642.2 MB)
  288. └─3ee562df86ca Size: 17.07 kB (virtual 642.2 MB)
  289. └─b05fc2d00e4a Size: 24.96 kB (virtual 642.2 MB)
  290. └─c96a99614930 Size: 12.29 kB (virtual 642.2 MB)
  291. └─a6a357a48c49 Size: 12.29 kB (virtual 642.2 MB) Tags: ndj/mongodb:latest
  292. .. _cli_import:
  293. ``import``
  294. ----------
  295. ::
  296. Usage: docker import URL|- [REPOSITORY[:TAG]]
  297. Create a new filesystem image from the contents of a tarball
  298. At this time, the URL must start with ``http`` and point to a single
  299. file archive (.tar, .tar.gz, .tgz, .bzip, .tar.xz, .txz) containing a
  300. root filesystem. If you would like to import from a local directory or
  301. archive, you can use the ``-`` parameter to take the data from
  302. standard in.
  303. Examples
  304. ~~~~~~~~
  305. Import from a remote location
  306. .............................
  307. This will create a new untagged image.
  308. ``$ sudo docker import http://example.com/exampleimage.tgz``
  309. Import from a local file
  310. ........................
  311. Import to docker via pipe and standard in
  312. ``$ cat exampleimage.tgz | sudo docker import - exampleimagelocal:new``
  313. Import from a local directory
  314. .............................
  315. ``$ sudo tar -c . | docker import - exampleimagedir``
  316. Note the ``sudo`` in this example -- you must preserve the ownership
  317. of the files (especially root ownership) during the archiving with
  318. tar. If you are not root (or sudo) when you tar, then the ownerships
  319. might not get preserved.
  320. .. _cli_info:
  321. ``info``
  322. --------
  323. ::
  324. Usage: docker info
  325. Display system-wide information.
  326. .. _cli_insert:
  327. ``insert``
  328. ----------
  329. ::
  330. Usage: docker insert IMAGE URL PATH
  331. Insert a file from URL in the IMAGE at PATH
  332. Examples
  333. ~~~~~~~~
  334. Insert file from github
  335. .......................
  336. .. code-block:: bash
  337. $ sudo docker insert 8283e18b24bc https://raw.github.com/metalivedev/django/master/postinstall /tmp/postinstall.sh
  338. .. _cli_inspect:
  339. ``inspect``
  340. -----------
  341. ::
  342. Usage: docker inspect [OPTIONS] CONTAINER
  343. Return low-level information on a container
  344. .. _cli_kill:
  345. ``kill``
  346. --------
  347. ::
  348. Usage: docker kill CONTAINER [CONTAINER...]
  349. Kill a running container (Send SIGKILL)
  350. The main process inside the container will be sent SIGKILL.
  351. Known Issues (kill)
  352. ~~~~~~~~~~~~~~~~~~~
  353. * :issue:`197` indicates that ``docker kill`` may leave directories
  354. behind and make it difficult to remove the container.
  355. .. _cli_login:
  356. ``login``
  357. ---------
  358. ::
  359. Usage: docker login [OPTIONS] [SERVER]
  360. Register or Login to the docker registry server
  361. -e="": email
  362. -p="": password
  363. -u="": username
  364. If you want to login to a private registry you can
  365. specify this by adding the server name.
  366. example:
  367. docker login localhost:8080
  368. .. _cli_logs:
  369. ``logs``
  370. --------
  371. ::
  372. Usage: docker logs [OPTIONS] CONTAINER
  373. Fetch the logs of a container
  374. .. _cli_port:
  375. ``port``
  376. --------
  377. ::
  378. Usage: docker port [OPTIONS] CONTAINER PRIVATE_PORT
  379. Lookup the public-facing port which is NAT-ed to PRIVATE_PORT
  380. .. _cli_ps:
  381. ``ps``
  382. ------
  383. ::
  384. Usage: docker ps [OPTIONS]
  385. List containers
  386. -a=false: Show all containers. Only running containers are shown by default.
  387. -notrunc=false: Don't truncate output
  388. -q=false: Only display numeric IDs
  389. .. _cli_pull:
  390. ``pull``
  391. --------
  392. ::
  393. Usage: docker pull NAME
  394. Pull an image or a repository from the registry
  395. .. _cli_push:
  396. ``push``
  397. --------
  398. ::
  399. Usage: docker push NAME
  400. Push an image or a repository to the registry
  401. .. _cli_restart:
  402. ``restart``
  403. -----------
  404. ::
  405. Usage: docker restart [OPTIONS] NAME
  406. Restart a running container
  407. .. _cli_rm:
  408. ``rm``
  409. ------
  410. ::
  411. Usage: docker rm [OPTIONS] CONTAINER
  412. Remove one or more containers
  413. -link="": Remove the link instead of the actual container
  414. Known Issues (rm)
  415. ~~~~~~~~~~~~~~~~~~~
  416. * :issue:`197` indicates that ``docker kill`` may leave directories
  417. behind and make it difficult to remove the container.
  418. Examples:
  419. ~~~~~~~~~
  420. .. code-block:: bash
  421. $ docker rm /redis
  422. /redis
  423. This will remove the container referenced under the link ``/redis``.
  424. .. code-block:: bash
  425. $ docker rm -link /webapp/redis
  426. /webapp/redis
  427. This will remove the underlying link between ``/webapp`` and the ``/redis`` containers removing all
  428. network communication.
  429. .. code-block:: bash
  430. $ docker rm `docker ps -a -q`
  431. This command will delete all stopped containers. The command ``docker ps -a -q`` will return all
  432. existing container IDs and pass them to the ``rm`` command which will delete them. Any running
  433. containers will not be deleted.
  434. .. _cli_rmi:
  435. ``rmi``
  436. -------
  437. ::
  438. Usage: docker rmi IMAGE [IMAGE...]
  439. Remove one or more images
  440. .. _cli_run:
  441. ``run``
  442. -------
  443. ::
  444. Usage: docker run [OPTIONS] IMAGE[:TAG] [COMMAND] [ARG...]
  445. Run a command in a new container
  446. -a=map[]: Attach to stdin, stdout or stderr
  447. -c=0: CPU shares (relative weight)
  448. -cidfile="": Write the container ID to the file
  449. -d=false: Detached mode: Run container in the background, print new container id
  450. -e=[]: Set environment variables
  451. -h="": Container host name
  452. -i=false: Keep stdin open even if not attached
  453. -privileged=false: Give extended privileges to this container
  454. -m="": Memory limit (format: <number><optional unit>, where unit = b, k, m or g)
  455. -n=true: Enable networking for this container
  456. -p=[]: Map a network port to the container
  457. -rm=false: Automatically remove the container when it exits (incompatible with -d)
  458. -t=false: Allocate a pseudo-tty
  459. -u="": Username or UID
  460. -dns=[]: Set custom dns servers for the container
  461. -v=[]: Create a bind mount with: [host-dir]:[container-dir]:[rw|ro]. If "container-dir" is missing, then docker creates a new volume.
  462. -volumes-from="": Mount all volumes from the given container(s)
  463. -entrypoint="": Overwrite the default entrypoint set by the image
  464. -w="": Working directory inside the container
  465. -lxc-conf=[]: Add custom lxc options -lxc-conf="lxc.cgroup.cpuset.cpus = 0,1"
  466. -sig-proxy=true: Proxify all received signal to the process (even in non-tty mode)
  467. -expose=[]: Expose a port from the container without publishing it to your host
  468. -link="": Add link to another container (name:alias)
  469. -name="": Assign the specified name to the container. If no name is specific docker will generate a random name
  470. -P=false: Publish all exposed ports to the host interfaces
  471. Examples
  472. --------
  473. .. code-block:: bash
  474. sudo docker run -cidfile /tmp/docker_test.cid ubuntu echo "test"
  475. This will create a container and print "test" to the console. The
  476. ``cidfile`` flag makes docker attempt to create a new file and write the
  477. container ID to it. If the file exists already, docker will return an
  478. error. Docker will close this file when docker run exits.
  479. .. code-block:: bash
  480. docker run mount -t tmpfs none /var/spool/squid
  481. This will *not* work, because by default, most potentially dangerous
  482. kernel capabilities are dropped; including ``cap_sys_admin`` (which is
  483. required to mount filesystems). However, the ``-privileged`` flag will
  484. allow it to run:
  485. .. code-block:: bash
  486. docker run -privileged mount -t tmpfs none /var/spool/squid
  487. The ``-privileged`` flag gives *all* capabilities to the container,
  488. and it also lifts all the limitations enforced by the ``device``
  489. cgroup controller. In other words, the container can then do almost
  490. everything that the host can do. This flag exists to allow special
  491. use-cases, like running Docker within Docker.
  492. .. code-block:: bash
  493. docker run -w /path/to/dir/ -i -t ubuntu pwd
  494. The ``-w`` lets the command being executed inside directory given,
  495. here /path/to/dir/. If the path does not exists it is created inside the
  496. container.
  497. .. code-block:: bash
  498. docker run -v `pwd`:`pwd` -w `pwd` -i -t ubuntu pwd
  499. The ``-v`` flag mounts the current working directory into the container.
  500. The ``-w`` lets the command being executed inside the current
  501. working directory, by changing into the directory to the value
  502. returned by ``pwd``. So this combination executes the command
  503. using the container, but inside the current working directory.
  504. .. code-block:: bash
  505. docker run -p 127.0.0.1:80:8080 ubuntu bash
  506. This binds port ``8080`` of the container to port ``80`` on 127.0.0.1 of the
  507. host machine. :ref:`port_redirection` explains in detail how to manipulate ports
  508. in Docker.
  509. .. code-block:: bash
  510. docker run -expose 80 ubuntu bash
  511. This exposes port ``80`` of the container for use within a link without
  512. publishing the port to the host system's interfaces. :ref:`port_redirection`
  513. explains in detail how to manipulate ports in Docker.
  514. .. code-block:: bash
  515. docker run -name console -t -i ubuntu bash
  516. This will create and run a new container with the container name
  517. being ``console``.
  518. .. code-block:: bash
  519. docker run -link /redis:redis -name console ubuntu bash
  520. The ``-link`` flag will link the container named ``/redis`` into the
  521. newly created container with the alias ``redis``. The new container
  522. can access the network and environment of the redis container via
  523. environment variables. The ``-name`` flag will assign the name ``console``
  524. to the newly created container.
  525. .. code-block:: bash
  526. docker run -volumes-from 777f7dc92da7,ba8c0c54f0f2:ro -i -t ubuntu pwd
  527. The ``-volumes-from`` flag mounts all the defined volumes from the
  528. refrence containers. Containers can be specified by a comma seperated
  529. list or by repetitions of the ``-volumes-from`` argument. The container
  530. id may be optionally suffixed with ``:ro`` or ``:rw`` to mount the volumes in
  531. read-only or read-write mode, respectively. By default, the volumes are mounted
  532. in the same mode (rw or ro) as the reference container.
  533. .. _cli_search:
  534. ``search``
  535. ----------
  536. ::
  537. Usage: docker search TERM
  538. Search the docker index for images
  539. -notrunc=false: Don't truncate output
  540. -stars=0: Only displays with at least xxx stars
  541. -trusted=false: Only show trusted builds
  542. .. _cli_start:
  543. ``start``
  544. ---------
  545. ::
  546. Usage: docker start [OPTIONS] NAME
  547. Start a stopped container
  548. -a=false: Attach container's stdout/stderr and forward all signals to the process
  549. -i=false: Attach container's stdin
  550. .. _cli_stop:
  551. ``stop``
  552. --------
  553. ::
  554. Usage: docker stop [OPTIONS] CONTAINER [CONTAINER...]
  555. Stop a running container (Send SIGTERM, and then SIGKILL after grace period)
  556. -t=10: Number of seconds to wait for the container to stop before killing it.
  557. The main process inside the container will receive SIGTERM, and after a grace period, SIGKILL
  558. .. _cli_tag:
  559. ``tag``
  560. -------
  561. ::
  562. Usage: docker tag [OPTIONS] IMAGE REPOSITORY[:TAG]
  563. Tag an image into a repository
  564. -f=false: Force
  565. .. _cli_top:
  566. ``top``
  567. -------
  568. ::
  569. Usage: docker top CONTAINER [ps OPTIONS]
  570. Lookup the running processes of a container
  571. .. _cli_version:
  572. ``version``
  573. -----------
  574. Show the version of the docker client, daemon, and latest released version.
  575. .. _cli_wait:
  576. ``wait``
  577. --------
  578. ::
  579. Usage: docker wait [OPTIONS] NAME
  580. Block until a container stops, then print its exit code.