{{ define "left" }} {{ partial "sidebar.html" . }} {{ end }} {{ define "main" }} {{ $data := "" }} {{ if .Params.datafolder }} {{ $data = index (index site.Data .Params.datafolder) .Params.datafile }} {{ else }} {{ $data = index site.Data .Params.datafile }} {{ end }} {{ .Scratch.Set "headings" slice }} {{ .Scratch.Set "subheadings" slice }} {{ partial "breadcrumbs.html" . }}

{{ .Title }}

{{ $data.short | .RenderString (dict "display" "block") }} {{ if $data.deprecated }}

This command is deprecated

It may be removed in a future Docker version. For more information, see the Docker roadmap

{{ end }} {{ if or $data.experimental $data.experimentalcli }}

This command is experimental

Experimental features are intended for testing and feedback as their functionality or design may change between releases without warning or can be removed entirely in a future release.

{{ end }} {{ with $data.kubernetes }}

{{ partial "components/badge.html" (dict "color" "blue" "content" "Kubernetes") }} This command works with the Kubernetes orchestrator.

{{ end }} {{ with $data.swarm }}

{{ partial "components/badge.html" (dict "color" "blue" "content" "Swarm") }} This command works with the Swarm orchestrator.

{{ end }} {{ with $data.usage }} {{ $heading := dict "level" 2 "text" "Usage" }} {{ partial "heading.html" $heading }} {{ $.Scratch.Add "headings" $heading }} {{ highlight (strings.Replace . "\t" "") "console" }} {{ end }} {{ with $data.long }} {{ $heading := dict "level" 2 "text" "Description" }} {{ partial "heading.html" $heading }} {{ $subHeadings := (strings.FindRE `(?m:#{3,4} .*)` .) }} {{ $.Scratch.Add "headings" $heading }} {{ range $subHeadings }} {{ $lvl := strings.Count "#" . }} {{ $txt := strings.TrimLeft "# " . }} {{ $.Scratch.Add "headings" (dict "level" $lvl "text" $txt) }} {{ end }} {{ . | $.RenderString (dict "display" "block") }} {{ end }} {{ with $data.options }} {{ $heading := dict "level" 2 "text" "Options" }} {{ partial "heading.html" $heading }} {{ $.Scratch.Add "headings" $heading }} {{ range . }} {{ $skipDefault := `[],map[],false,0,0s,default,'',""` }} {{ end }}
Option Short Default Description
{{ with .option }}--{{ . }}{{ end }} {{ with .shorthand }}-{{ . }}{{ end }} {{ with .default_value }} {{ cond (in $skipDefault .) "" (printf "%s" . | safeHTML) }} {{ end }} {{ with .min_api_version }} {{ partial "components/badge.html" (dict "color" "blue" "content" (printf "API %s+" .)) }} {{ end }} {{ with .deprecated }} {{ partial "components/badge.html" (dict "color" "red" "content" "Deprecated") }} {{ end }} {{ with .experimental }} {{ partial "components/badge.html" (dict "color" "amber" "content" "experimental (daemon)") }} {{ end }} {{ with .experimentalcli }} {{ partial "components/badge.html" (dict "color" "amber" "content" "experimental (CLI)") }} {{ end }} {{ with .kubernetes }} {{ partial "components/badge.html" (dict "color" "blue" "content" "Kubernetes") }} {{ end }} {{ with .swarm }} {{ partial "components/badge.html" (dict "color" "blue" "content" "Swarm") }} {{ end }} {{ if .description }} {{ $.RenderString .description }} {{ end }}
{{ end }} {{ with $data.examples }} {{ $heading := dict "level" 2 "text" "Examples" }} {{ partial "heading.html" $heading }} {{ $subHeadings := (strings.FindRE `(?m:#{3,4} .*)` .) }} {{ $.Scratch.Add "headings" $heading }} {{ range $subHeadings }} {{ $lvl := strings.Count "#" . }} {{ $txt := strings.TrimLeft "# " . }} {{ $.Scratch.Add "headings" (dict "level" $lvl "text" $txt) }} {{ end }} {{ $.RenderString (dict "display" "block") . }} {{ end }} {{ .Content }}
{{ end }} {{ define "right" }} {{ partial "cli-aside.html" . }} {{ end }}