id = "docker-machine"
name = "Docker Machine"
homepage = "https://docs.docker.com/retired/"
description = "A tool for provisioning and managing Docker hosts."
executables = ["docker-machine"]
[dotfiles]
paths = ["~/.docker/machine/"]
secret = ["~/.docker/machine/machines/*/"]
[commands]
format = 1
label = "Docker Machine"
description = "List, create, remove machines and print their environment. Driver-specific options are left out."
quality = "ai-draft"
parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = false, short_bundles = false }
[[commands.subcommand]]
path = ["ls"]
label = "List machines"
[[commands.subcommand.source]]
id = "src"
kind = "help"
url = "https://github.com/docker-archive-public/docker.machine/blob/master/commands/commands.go"
evidence = """
Name: "ls",
Usage: "List machines",
Name: "quiet, q",
Usage: "Enable quiet mode",
Name: "filter",
Usage: "Filter output based on conditions provided",
Name: "timeout, t",
Name: "format, f",
Usage: "Pretty-print machines using a Go template",
flag names: --quiet, -q, --filter, --timeout, -t, --format, -f
"""
[[commands.subcommand.field]]
id = "quiet"
label = "Names only"
type = "boolean"
option = ["--quiet", "-q"]
sources = ["src"]
[[commands.subcommand.field]]
id = "filter"
label = "Filters"
description = "For example state=Running or driver=virtualbox."
type = "string"
option = ["--filter"]
multiple = true
sources = ["src"]
[[commands.subcommand.field]]
id = "timeout"
label = "Timeout (seconds)"
description = "Default 10."
type = "integer"
option = ["--timeout", "-t"]
sources = ["src"]
[[commands.subcommand.field]]
id = "format"
label = "Go template"
type = "string"
option = ["--format", "-f"]
sources = ["src"]
[[commands.subcommand.task]]
id = "list"
label = "List machines"
fields = ["quiet", "filter"]
required = []
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["quiet", "filter"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["timeout", "format"]
[[commands.subcommand]]
path = ["create"]
label = "Create a machine"
[[commands.subcommand.source]]
id = "src"
kind = "help"
url = "https://github.com/docker-archive-public/docker.machine/blob/master/commands/create.go"
evidence = """
Name: "create",
Usage: "Create a machine",
Name: "driver, d",
Usage: "Driver to create machine with.",
Name: "engine-opt",
Name: "engine-label",
Name: "swarm",
flag names: --driver, -d, --engine-opt, --engine-label
"""
[[commands.subcommand.field]]
id = "machine"
label = "Machine name"
type = "string"
position = 0
sources = ["src"]
[[commands.subcommand.field]]
id = "driver"
label = "Driver"
type = "string"
option = ["--driver", "-d"]
suggestions = [{ value = "virtualbox", label = "VirtualBox" }, { value = "vmwarefusion", label = "VMware Fusion" }, { value = "hyperv", label = "Hyper-V" }, { value = "generic", label = "Generic SSH host" }]
sources = ["src"]
[[commands.subcommand.field]]
id = "engine_opt"
label = "Engine options"
description = "flag=value, one per entry."
type = "string"
option = ["--engine-opt"]
multiple = true
sources = ["src"]
[[commands.subcommand.field]]
id = "engine_label"
label = "Engine labels"
type = "string"
option = ["--engine-label"]
multiple = true
sources = ["src"]
[[commands.subcommand.task]]
id = "create"
label = "Create a machine"
fields = ["machine", "driver"]
required = ["machine", "driver"]
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["machine", "driver"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["engine_opt", "engine_label"]
[[commands.subcommand]]
path = ["env"]
label = "Show machine environment"
[[commands.subcommand.source]]
id = "src"
kind = "help"
url = "https://github.com/docker-archive-public/docker.machine/blob/master/commands/commands.go"
evidence = """
Name: "env",
Usage: "Display the commands to set up the environment for the Docker client",
Name: "shell",
Usage: "Force environment to be configured for a specified shell: [fish, cmd, powershell, tcsh, emacs], default is auto-detect",
Name: "unset, u",
Usage: "Unset variables instead of setting them",
Name: "no-proxy",
flag names: --shell, --unset, -u, --no-proxy
"""
[[commands.subcommand.field]]
id = "machine"
label = "Machine name"
type = "string"
position = 0
sources = ["src"]
[[commands.subcommand.field]]
id = "shell"
label = "Shell"
type = "enum"
option = ["--shell"]
choices = [{ value = "fish", label = "fish" }, { value = "cmd", label = "cmd" }, { value = "powershell", label = "PowerShell" }, { value = "tcsh", label = "tcsh" }, { value = "emacs", label = "Emacs" }]
sources = ["src"]
[[commands.subcommand.field]]
id = "unset"
label = "Unset variables"
type = "boolean"
option = ["--unset", "-u"]
sources = ["src"]
[[commands.subcommand.field]]
id = "no_proxy"
label = "Add IP to NO_PROXY"
type = "boolean"
option = ["--no-proxy"]
sources = ["src"]
[[commands.subcommand.task]]
id = "env"
label = "Show environment"
fields = ["machine", "shell"]
required = []
[[commands.subcommand.task]]
id = "unset"
label = "Unset environment"
fields = ["machine", "unset"]
required = []
set = { unset = [true] }
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["machine", "shell", "unset"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["no_proxy"]
[[commands.subcommand]]
path = ["rm"]
label = "Remove machines"
[[commands.subcommand.source]]
id = "src"
kind = "help"
url = "https://github.com/docker-archive-public/docker.machine/blob/master/commands/commands.go"
evidence = """
Name: "rm",
Usage: "Remove a machine",
Name: "force, f",
Usage: "Remove local configuration even if machine cannot be removed, also implies an automatic yes (`-y`)",
Name: "y",
Usage: "Assumes automatic yes to proceed with remove, without prompting further user confirmation",
flag names: --force, -f, -y
"""
[[commands.subcommand.field]]
id = "machines"
label = "Machines"
type = "string"
position = 0
multiple = true
sources = ["src"]
[[commands.subcommand.field]]
id = "force"
label = "Force"
type = "boolean"
option = ["--force", "-f"]
effect = "delete"
sources = ["src"]
[[commands.subcommand.field]]
id = "yes"
label = "Assume yes"
type = "boolean"
option = ["-y"]
effect = "delete"
sources = ["src"]
[[commands.subcommand.task]]
id = "remove"
label = "Remove machines"
fields = ["machines", "force"]
required = ["machines"]
[[commands.subcommand.group]]
id = "basic"
label = "Basic"
fields = ["machines", "force"]
[[commands.subcommand.group]]
id = "advanced"
label = "Advanced"
fields = ["yes"]