layouts/cli.html
{{ partial "breadcrumbs.html" . }}
{{ partial "md-dropdown.html" . }}
{{ with $data.short }} | Description | {{ . }} |
{{ end }} {{ with $data.usage }} | Usage | {{ . }} |
{{ end }} {{ with $data.aliases }} {{ $aliases := strings.Replace . (fmt.Printf "%s, " page.Title) "" }} | Aliases {{ partialCached "tooltip.html" "An alias is a short or memorable alternative for a longer command." "cli-alias" }} |
{{ range (strings.Split $aliases ", ") }} {{ . }} {{ end }}
|
{{ end }}
{{ if $data.deprecated }} {{ markdownify \> [!WARNING] \> This command is deprecated \> \> It may be removed in a future Docker version. For more information, see the \> [Docker roadmap](https://github.com/docker/roadmap/issues/209) }} {{ end }} {{ if or $data.experimental $data.experimentalcli }} {{ markdownify {{% experimental %}} **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. {{% /experimental %}} }} {{ end }} {{ with $data.kubernetes }}
{{ partialCached "components/badge.html" (dict "color" "blue" "content" "Kubernetes") "k8s" }} This command works with the Kubernetes orchestrator.
{{ end }} {{ with $data.swarm }}
{{ partialCached "components/badge.html" (dict "color" "blue" "content" "Swarm") "swarm" }} This command works with the Swarm orchestrator.
{{ end }} {{ with $data.long }} {{ $heading := dict "level" 2 "text" "Description" }} {{ partialCached "heading.html" $heading "cli-description" }} {{ $subHeadings := (strings.FindRE (?m:#{3,4} .*) .) }} {{ $.Store.Add "headings" $heading }} {{ range $subHeadings }} {{ $lvl := strings.Count "#" . }} {{ $txt := strings.TrimLeft "# " . }} {{ $.Store.Add "headings" (dict "level" $lvl "text" $txt) }} {{ end }} {{ . | $.RenderString (dict "display" "block") }} {{ end }} {{ with $data.options }} {{ $opts := where . "hidden" false }} {{ with $opts }} {{ $heading := dict "level" 2 "text" "Options" }} {{ partialCached "heading.html" $heading "cli-options" }} {{ $.Store.Add "headings" $heading }}
| Option | Default | Description |
|---|---|---|
| {{ range . }} | {{ $short := .shorthand }} {{ $long := .option }} {{ with .details_url }} {{ with $short }}-{{ . }}, {{end}}--{{ $long }} {{ else }} {{ with $short }}-{{ . }}, {{end}}--{{ $long }} {{ end }} | {{ $skipDefault := [],map[],false,0,0s,default,'',"" }} {{ with .default_value }} {{ cond (in $skipDefault .) "" (printf "%s" . |
| ") }} {{ end }} | ||
| {{ end }} |
{{ end }} {{ end }} {{ with $data.examples }} {{ $heading := dict "level" 2 "text" "Examples" }} {{ partialCached "heading.html" $heading "cli-examples" }} {{ $subHeadings := (strings.FindRE (?m:#{3,4} .*) .) }} {{ $.Store.Add "headings" $heading }} {{ range $subHeadings }} {{ $lvl := strings.Count "#" . }} {{ $txt := strings.TrimLeft "# " . }} {{ $.Store.Add "headings" (dict "level" $lvl "text" $txt) }} {{ end }} {{ $.RenderString (dict "display" "block") . }} {{ end }} {{ if eq .Kind "section" }} {{ $heading := dict "level" 2 "text" "Subcommands" }} {{ partialCached "heading.html" $heading "cli-subcommands" }} {{ $.Store.Add "headings" $heading }}
| Command | Description |
|---|---|
| {{ range .Pages }} {{- if and .Params.datafolder .Params.datafile }} | {{ .Title }} {{ $data := index site.Data.cli .Params.datafolder .Params.datafile }} |
| {{- end }} {{ end }} | |
| {{ end }} |