浏览代码

[v2] docs: regenerate yaml docs

Signed-off-by: Sebastiaan van Stijn <[email protected]>
Sebastiaan van Stijn 4 年之前
父节点
当前提交
1c01e9d00f

文件差异内容过多而无法显示
+ 0 - 51
docs/reference/docker_compose.yaml


+ 92 - 97
docs/reference/docker_compose_build.yaml

@@ -1,108 +1,103 @@
 command: docker compose build
 short: Build or rebuild services
-long: "Services are built once and then tagged, by default as `project_service`. \n\nIf
-    the Compose file specifies an\n[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image)
-    name, \nthe image is tagged with that name, substituting any variables beforehand.
-    See\n[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).\n\nIf
-    you change a service's `Dockerfile` or the contents of its build directory, \nrun
-    `docker compose build` to rebuild it."
+long: "Services are built once and then tagged, by default as `project_service`. \n\nIf the Compose file specifies an\n[image](https://github.com/compose-spec/compose-spec/blob/master/spec.md#image) name, \nthe image is tagged with that name, substituting any variables beforehand. See\n[variable interpolation](https://github.com/compose-spec/compose-spec/blob/master/spec.md#interpolation).\n\nIf you change a service's `Dockerfile` or the contents of its build directory, \nrun `docker compose build` to rebuild it."
 usage: docker compose build [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: build-arg
-    value_type: stringArray
-    default_value: '[]'
-    description: Set build-time variables for services.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: compress
-    value_type: bool
-    default_value: "true"
-    description: Compress the build context using gzip. DEPRECATED
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: force-rm
-    value_type: bool
-    default_value: "true"
-    description: Always remove intermediate containers. DEPRECATED
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: memory
-    shorthand: m
-    value_type: string
-    description: |
+    - option: build-arg
+      value_type: stringArray
+      default_value: '[]'
+      description: Set build-time variables for services.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: compress
+      value_type: bool
+      default_value: "true"
+      description: Compress the build context using gzip. DEPRECATED
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: force-rm
+      value_type: bool
+      default_value: "true"
+      description: Always remove intermediate containers. DEPRECATED
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: memory
+      shorthand: m
+      value_type: string
+      description: |
         Set memory limit for the build container. Not supported on buildkit yet.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-cache
-    value_type: bool
-    default_value: "false"
-    description: Do not use cache when building the image
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-rm
-    value_type: bool
-    default_value: "false"
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-cache
+      value_type: bool
+      default_value: "false"
+      description: Do not use cache when building the image
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-rm
+      value_type: bool
+      default_value: "false"
+      description: |
         Do not remove intermediate containers after a successful build. DEPRECATED
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: parallel
-    value_type: bool
-    default_value: "true"
-    description: Build images in parallel. DEPRECATED
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: progress
-    value_type: string
-    default_value: auto
-    description: Set type of progress output ("auto", "plain", "noTty")
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: pull
-    value_type: bool
-    default_value: "false"
-    description: Always attempt to pull a newer version of the image.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: quiet
-    shorthand: q
-    value_type: bool
-    default_value: "false"
-    description: Don't print anything to STDOUT
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: parallel
+      value_type: bool
+      default_value: "true"
+      description: Build images in parallel. DEPRECATED
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: progress
+      value_type: string
+      default_value: auto
+      description: Set type of progress output ("auto", "plain", "noTty")
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: pull
+      value_type: bool
+      default_value: "false"
+      description: Always attempt to pull a newer version of the image.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: quiet
+      shorthand: q
+      value_type: bool
+      default_value: "false"
+      description: Don't print anything to STDOUT
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 73 - 77
docs/reference/docker_compose_convert.yaml

@@ -1,87 +1,83 @@
 command: docker compose convert
 aliases: config
 short: Converts the compose file to platform's canonical format
-long: "`docker compose convert` render the actual data model to be applied on target
-    platform. When used with Docker engine,\nit merges the Compose files set by `-f`
-    flags, resolves variables in Compose file, and expands short-notation into \nfully
-    defined Compose model. \n\nTo allow smooth migration from docker-compose, this
-    subcommand declares alias `docker compose config`"
+long: "`docker compose convert` render the actual data model to be applied on target platform. When used with Docker engine,\nit merges the Compose files set by `-f` flags, resolves variables in Compose file, and expands short-notation into \nfully defined Compose model. \n\nTo allow smooth migration from docker-compose, this subcommand declares alias `docker compose config`"
 usage: docker compose convert SERVICES
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: format
-    value_type: string
-    default_value: yaml
-    description: 'Format the output. Values: [yaml | json]'
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: hash
-    value_type: string
-    description: Print the service config hash, one per line.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-interpolate
-    value_type: bool
-    default_value: "false"
-    description: Don't interpolate environment variables.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: profiles
-    value_type: bool
-    default_value: "false"
-    description: Print the profile names, one per line.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: quiet
-    shorthand: q
-    value_type: bool
-    default_value: "false"
-    description: Only validate the configuration, don't print anything.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: resolve-image-digests
-    value_type: bool
-    default_value: "false"
-    description: Pin image tags to digests.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: services
-    value_type: bool
-    default_value: "false"
-    description: Print the service names, one per line.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: volumes
-    value_type: bool
-    default_value: "false"
-    description: Print the volume names, one per line.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: format
+      value_type: string
+      default_value: yaml
+      description: 'Format the output. Values: [yaml | json]'
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: hash
+      value_type: string
+      description: Print the service config hash, one per line.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-interpolate
+      value_type: bool
+      default_value: "false"
+      description: Don't interpolate environment variables.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: profiles
+      value_type: bool
+      default_value: "false"
+      description: Print the profile names, one per line.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: quiet
+      shorthand: q
+      value_type: bool
+      default_value: "false"
+      description: Only validate the configuration, don't print anything.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: resolve-image-digests
+      value_type: bool
+      default_value: "false"
+      description: Pin image tags to digests.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: services
+      value_type: bool
+      default_value: "false"
+      description: Print the service names, one per line.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: volumes
+      value_type: bool
+      default_value: "false"
+      description: Print the volume names, one per line.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 38 - 38
docs/reference/docker_compose_cp.yaml

@@ -7,45 +7,45 @@ usage: |-
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: all
-    value_type: bool
-    default_value: "false"
-    description: Copy to all the containers of the service.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: archive
-    shorthand: a
-    value_type: bool
-    default_value: "false"
-    description: Archive mode (copy all uid/gid information)
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: follow-link
-    shorthand: L
-    value_type: bool
-    default_value: "false"
-    description: Always follow symbol link in SRC_PATH
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: index
-    value_type: int
-    default_value: "1"
-    description: |
+    - option: all
+      value_type: bool
+      default_value: "false"
+      description: Copy to all the containers of the service.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: archive
+      shorthand: a
+      value_type: bool
+      default_value: "false"
+      description: Archive mode (copy all uid/gid information)
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: follow-link
+      shorthand: L
+      value_type: bool
+      default_value: "false"
+      description: Always follow symbol link in SRC_PATH
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: index
+      value_type: int
+      default_value: "1"
+      description: |
         Index of the container if there are multiple instances of a service [default: 1].
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 36 - 36
docs/reference/docker_compose_create.yaml

@@ -5,44 +5,44 @@ usage: docker compose create [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: build
-    value_type: bool
-    default_value: "false"
-    description: Build images before starting containers.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: force-recreate
-    value_type: bool
-    default_value: "false"
-    description: |
+    - option: build
+      value_type: bool
+      default_value: "false"
+      description: Build images before starting containers.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: force-recreate
+      value_type: bool
+      default_value: "false"
+      description: |
         Recreate containers even if their configuration and image haven't changed.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-build
-    value_type: bool
-    default_value: "false"
-    description: Don't build an image, even if it's missing.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-recreate
-    value_type: bool
-    default_value: "false"
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-build
+      value_type: bool
+      default_value: "false"
+      description: Don't build an image, even if it's missing.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-recreate
+      value_type: bool
+      default_value: "false"
+      description: |
         If containers already exist, don't recreate them. Incompatible with --force-recreate.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 37 - 37
docs/reference/docker_compose_down.yaml

@@ -18,46 +18,46 @@ usage: docker compose down
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: remove-orphans
-    value_type: bool
-    default_value: "false"
-    description: |
+    - option: remove-orphans
+      value_type: bool
+      default_value: "false"
+      description: |
         Remove containers for services not defined in the Compose file.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: rmi
-    value_type: string
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: rmi
+      value_type: string
+      description: |
         Remove images used by services. "local" remove only images that don't have a custom tag ("local"|"all")
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: timeout
-    shorthand: t
-    value_type: int
-    default_value: "10"
-    description: Specify a shutdown timeout in seconds
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: volumes
-    shorthand: v
-    value_type: bool
-    default_value: "false"
-    description: |4
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: timeout
+      shorthand: t
+      value_type: int
+      default_value: "10"
+      description: Specify a shutdown timeout in seconds
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: volumes
+      shorthand: v
+      value_type: bool
+      default_value: "false"
+      description: |4
          Remove named volumes declared in the `volumes` section of the Compose file and anonymous volumes attached to containers.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 9 - 9
docs/reference/docker_compose_events.yaml

@@ -24,15 +24,15 @@ usage: docker compose events [options] [--] [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: json
-    value_type: bool
-    default_value: "false"
-    description: Output events as a stream of json objects
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: json
+      value_type: bool
+      default_value: "false"
+      description: Output events as a stream of json objects
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 68 - 71
docs/reference/docker_compose_exec.yaml

@@ -1,81 +1,78 @@
 command: docker compose exec
 short: Execute a command in a running container.
-long: "This is the equivalent of `docker exec` targeting a Compose service. \n\nWith
-    this subcommand you can run arbitrary commands in your services. Commands are
-    by default allocating a TTY, so \nyou can use a command such as `docker compose
-    exec web sh` to get an interactive prompt."
+long: "This is the equivalent of `docker exec` targeting a Compose service. \n\nWith this subcommand you can run arbitrary commands in your services. Commands are by default allocating a TTY, so \nyou can use a command such as `docker compose exec web sh` to get an interactive prompt."
 usage: docker compose exec [options] [-e KEY=VAL...] [--] SERVICE COMMAND [ARGS...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: ""
-    shorthand: T
-    value_type: bool
-    default_value: "false"
-    description: |
-        Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: detach
-    shorthand: d
-    value_type: bool
-    default_value: "false"
-    description: 'Detached mode: Run command in the background.'
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: env
-    shorthand: e
-    value_type: stringArray
-    default_value: '[]'
-    description: Set environment variables
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: index
-    value_type: int
-    default_value: "1"
-    description: |
+    - option: detach
+      shorthand: d
+      value_type: bool
+      default_value: "false"
+      description: 'Detached mode: Run command in the background.'
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: env
+      shorthand: e
+      value_type: stringArray
+      default_value: '[]'
+      description: Set environment variables
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: index
+      value_type: int
+      default_value: "1"
+      description: |
         index of the container if there are multiple instances of a service [default: 1].
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: privileged
-    value_type: bool
-    default_value: "false"
-    description: Give extended privileges to the process.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: user
-    shorthand: u
-    value_type: string
-    description: Run the command as this user.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: workdir
-    shorthand: w
-    value_type: string
-    description: Path to workdir directory for this command.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-TTY
+      shorthand: T
+      value_type: bool
+      default_value: "false"
+      description: |
+        Disable pseudo-TTY allocation. By default `docker compose exec` allocates a TTY.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: privileged
+      value_type: bool
+      default_value: "false"
+      description: Give extended privileges to the process.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: user
+      shorthand: u
+      value_type: string
+      description: Run the command as this user.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: workdir
+      shorthand: w
+      value_type: string
+      description: Path to workdir directory for this command.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 10 - 10
docs/reference/docker_compose_images.yaml

@@ -5,16 +5,16 @@ usage: docker compose images [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: quiet
-    shorthand: q
-    value_type: bool
-    default_value: "false"
-    description: Only display IDs
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: quiet
+      shorthand: q
+      value_type: bool
+      default_value: "false"
+      description: Only display IDs
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 10 - 10
docs/reference/docker_compose_kill.yaml

@@ -10,16 +10,16 @@ usage: docker compose kill [options] [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: signal
-    shorthand: s
-    value_type: string
-    default_value: SIGKILL
-    description: SIGNAL to send to the container.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: signal
+      shorthand: s
+      value_type: string
+      default_value: SIGKILL
+      description: SIGNAL to send to the container.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 67 - 39
docs/reference/docker_compose_logs.yaml

@@ -1,48 +1,76 @@
 command: docker compose logs
 short: View output from containers
 long: Displays log output from services.
-usage: docker compose logs [service...]
+usage: docker compose logs [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: follow
-    shorthand: f
-    value_type: bool
-    default_value: "false"
-    description: Follow log output.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-color
-    value_type: bool
-    default_value: "false"
-    description: Produce monochrome output.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-log-prefix
-    value_type: bool
-    default_value: "false"
-    description: Don't print prefix in logs.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: timestamps
-    shorthand: t
-    value_type: bool
-    default_value: "false"
-    description: Show timestamps.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: follow
+      shorthand: f
+      value_type: bool
+      default_value: "false"
+      description: Follow log output.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-color
+      value_type: bool
+      default_value: "false"
+      description: Produce monochrome output.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-log-prefix
+      value_type: bool
+      default_value: "false"
+      description: Don't print prefix in logs.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: since
+      value_type: string
+      description: |
+        Show logs since timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: tail
+      value_type: string
+      default_value: all
+      description: |
+        Number of lines to show from the end of the logs for each container.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: timestamps
+      shorthand: t
+      value_type: bool
+      default_value: "false"
+      description: Show timestamps.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: until
+      value_type: string
+      description: |
+        Show logs before a timestamp (e.g. 2013-01-02T13:23:37Z) or relative (e.g. 42m for 42 minutes)
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 37 - 27
docs/reference/docker_compose_ls.yaml

@@ -5,33 +5,43 @@ usage: docker compose ls
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: filter
-    value_type: filter
-    description: Filter output based on conditions provided.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: format
-    value_type: string
-    default_value: pretty
-    description: 'Format the output. Values: [pretty | json].'
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: quiet
-    shorthand: q
-    value_type: bool
-    default_value: "false"
-    description: Only display IDs.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: all
+      shorthand: a
+      value_type: bool
+      default_value: "false"
+      description: Show all stopped Compose projects
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: filter
+      value_type: filter
+      description: Filter output based on conditions provided.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: format
+      value_type: string
+      default_value: pretty
+      description: 'Format the output. Values: [pretty | json].'
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: quiet
+      shorthand: q
+      value_type: bool
+      default_value: "false"
+      description: Only display IDs.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 1 - 2
docs/reference/docker_compose_pause.yaml

@@ -1,7 +1,6 @@
 command: docker compose pause
 short: pause services
-long: Pauses running containers of a service. They can be unpaused with `docker compose
-    unpause`.
+long: Pauses running containers of a service. They can be unpaused with `docker compose unpause`.
 usage: docker compose pause [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml

+ 18 - 18
docs/reference/docker_compose_port.yaml

@@ -5,24 +5,24 @@ usage: docker compose port [options] [--] SERVICE PRIVATE_PORT
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: index
-    value_type: int
-    default_value: "1"
-    description: index of the container if service has multiple replicas
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: protocol
-    value_type: string
-    default_value: tcp
-    description: tcp or udp
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: index
+      value_type: int
+      default_value: "1"
+      description: index of the container if service has multiple replicas
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: protocol
+      value_type: string
+      default_value: tcp
+      description: tcp or udp
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 56 - 43
docs/reference/docker_compose_ps.yaml

@@ -1,52 +1,65 @@
 command: docker compose ps
 short: List containers
-long: "Lists containers for a Compose project, with current status and exposed ports.\n\n```\n$
-    docker compose ps\nNAME                SERVICE             STATUS              PORTS\nexample_foo_1
-    \      foo                 running (healthy)   0.0.0.0:8000->80/tcp\nexample_bar_1
-    \      bar                 exited (1)          \n```"
-usage: docker compose ps
+long: "Lists containers for a Compose project, with current status and exposed ports.\n\n```\n$ docker compose ps\nNAME                SERVICE             STATUS              PORTS\nexample_foo_1       foo                 running (healthy)   0.0.0.0:8000->80/tcp\nexample_bar_1       bar                 exited (1)          \n```"
+usage: docker compose ps [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: all
-    shorthand: a
-    value_type: bool
-    default_value: "false"
-    description: |
+    - option: all
+      shorthand: a
+      value_type: bool
+      default_value: "false"
+      description: |
         Show all stopped containers (including those created by the run command)
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: format
-    value_type: string
-    default_value: pretty
-    description: 'Format the output. Values: [pretty | json].'
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: quiet
-    shorthand: q
-    value_type: bool
-    default_value: "false"
-    description: Only display IDs
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: services
-    value_type: bool
-    default_value: "false"
-    description: Display services
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: filter
+      value_type: string
+      description: Filter services by a property
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: format
+      value_type: string
+      default_value: pretty
+      description: 'Format the output. Values: [pretty | json]'
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: quiet
+      shorthand: q
+      value_type: bool
+      default_value: "false"
+      description: Only display IDs
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: services
+      value_type: bool
+      default_value: "false"
+      description: Display services
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: status
+      value_type: string
+      description: Filter services by status
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 48 - 71
docs/reference/docker_compose_pull.yaml

@@ -1,80 +1,57 @@
 command: docker compose pull
 short: Pull service images
-long: "Pulls an image associated with a service defined in a `compose.yaml` file,
-    but does not start containers based on \nthose images."
+long: "Pulls an image associated with a service defined in a `compose.yaml` file, but does not start containers based on \nthose images."
 usage: docker compose pull [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: ignore-pull-failures
-    value_type: bool
-    default_value: "false"
-    description: Pull what it can and ignores images with pull failures
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: include-deps
-    value_type: bool
-    default_value: "false"
-    description: Also pull services declared as dependencies
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-parallel
-    value_type: bool
-    default_value: "true"
-    description: DEPRECATED disable parallel pulling.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: parallel
-    value_type: bool
-    default_value: "true"
-    description: DEPRECATED pull multiple images in parallel.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: quiet
-    shorthand: q
-    value_type: bool
-    default_value: "false"
-    description: Pull without printing progress information
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-examples: "suppose you have this `compose.yaml` file from the Quickstart: [Compose
-    and Rails sample](compose/rails/).\n\n```yaml\nservices:\n  db:\n    image: postgres\n
-    \ web:\n    build: .\n    command: bundle exec rails s -p 3000 -b '0.0.0.0'\n
-    \   volumes:\n    - .:/myapp\n    ports:\n    - \"3000:3000\"\n    depends_on:\n
-    \   - db\n```\n\nIf you run `docker compose pull ServiceName` in the same directory
-    as the `ccompose.yaml` file that defines the service, \nDocker pulls the associated
-    image. For example, to call the postgres image configured as the db service in
-    our example, \nyou would run `docker compose pull db`.\n\n```\n$ docker compose
-    pull db\n[+] Running 1/15\n ⠸ db Pulling                                                             12.4s\n
-    \  ⠿ 45b42c59be33 Already exists                                           0.0s\n
-    \  ⠹ 40adec129f1a Downloading  3.374MB/4.178MB                             9.3s\n
-    \  ⠹ b4c431d00c78 Download complete                                        9.3s\n
-    \  ⠹ 2696974e2815 Download complete                                        9.3s\n
-    \  ⠹ 564b77596399 Downloading  5.622MB/7.965MB                             9.3s\n
-    \  ⠹ 5044045cf6f2 Downloading  216.7kB/391.1kB                             9.3s\n
-    \  ⠹ d736e67e6ac3 Waiting                                                  9.3s\n
-    \  ⠹ 390c1c9a5ae4 Waiting                                                  9.3s\n
-    \  ⠹ c0e62f172284 Waiting                                                  9.3s\n
-    \  ⠹ ebcdc659c5bf Waiting                                                  9.3s\n
-    \  ⠹ 29be22cb3acc Waiting                                                  9.3s\n
-    \  ⠹ f63c47038e66 Waiting                                                  9.3s\n
-    \  ⠹ 77a0c198cde5 Waiting                                                  9.3s\n
-    \  ⠹ c8752d5b785c Waiting                                                  9.3s\n``̀"
+    - option: ignore-pull-failures
+      value_type: bool
+      default_value: "false"
+      description: Pull what it can and ignores images with pull failures
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: include-deps
+      value_type: bool
+      default_value: "false"
+      description: Also pull services declared as dependencies
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-parallel
+      value_type: bool
+      default_value: "true"
+      description: DEPRECATED disable parallel pulling.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: parallel
+      value_type: bool
+      default_value: "true"
+      description: DEPRECATED pull multiple images in parallel.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: quiet
+      shorthand: q
+      value_type: bool
+      default_value: "false"
+      description: Pull without printing progress information
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+examples: "suppose you have this `compose.yaml` file from the Quickstart: [Compose and Rails sample](compose/rails/).\n\n```yaml\nservices:\n  db:\n    image: postgres\n  web:\n    build: .\n    command: bundle exec rails s -p 3000 -b '0.0.0.0'\n    volumes:\n    - .:/myapp\n    ports:\n    - \"3000:3000\"\n    depends_on:\n    - db\n```\n\nIf you run `docker compose pull ServiceName` in the same directory as the `ccompose.yaml` file that defines the service, \nDocker pulls the associated image. For example, to call the postgres image configured as the db service in our example, \nyou would run `docker compose pull db`.\n\n```\n$ docker compose pull db\n[+] Running 1/15\n ⠸ db Pulling                                                             12.4s\n   ⠿ 45b42c59be33 Already exists                                           0.0s\n   ⠹ 40adec129f1a Downloading  3.374MB/4.178MB                             9.3s\n   ⠹ b4c431d00c78 Download complete                                        9.3s\n   ⠹ 2696974e2815 Download complete                                        9.3s\n   ⠹ 564b77596399 Downloading  5.622MB/7.965MB                             9.3s\n   ⠹ 5044045cf6f2 Downloading  216.7kB/391.1kB                             9.3s\n   ⠹ d736e67e6ac3 Waiting                                                  9.3s\n   ⠹ 390c1c9a5ae4 Waiting                                                  9.3s\n   ⠹ c0e62f172284 Waiting                                                  9.3s\n   ⠹ ebcdc659c5bf Waiting                                                  9.3s\n   ⠹ 29be22cb3acc Waiting                                                  9.3s\n   ⠹ f63c47038e66 Waiting                                                  9.3s\n   ⠹ 77a0c198cde5 Waiting                                                  9.3s\n   ⠹ c8752d5b785c Waiting                                                  9.3s\n``̀"
 deprecated: false
 experimental: false
 experimentalcli: false

+ 10 - 15
docs/reference/docker_compose_push.yaml

@@ -1,24 +1,19 @@
 command: docker compose push
 short: Push service images
-long: "Pushes images for services to their respective registry/repository.\n\nThe
-    following assumptions are made:\n- You are pushing an image you have built locally\n-
-    You have access to the build key\n\nExamples\n\n```yaml\nservices:\n    service1:\n
-    \       build: .\n        image: localhost:5000/yourimage  ## goes to local registry\n
-    \   \n    service2:\n        build: .\n        image: your-dockerid/yourimage
-    \ ## goes to your repository on Docker Hub\n```"
+long: "Pushes images for services to their respective registry/repository.\n\nThe following assumptions are made:\n- You are pushing an image you have built locally\n- You have access to the build key\n\nExamples\n\n```yaml\nservices:\n    service1:\n        build: .\n        image: localhost:5000/yourimage  ## goes to local registry\n    \n    service2:\n        build: .\n        image: your-dockerid/yourimage  ## goes to your repository on Docker Hub\n```"
 usage: docker compose push [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: ignore-push-failures
-    value_type: bool
-    default_value: "false"
-    description: Push what it can and ignores images with push failures
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: ignore-push-failures
+      value_type: bool
+      default_value: "false"
+      description: Push what it can and ignores images with push failures
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 10 - 10
docs/reference/docker_compose_restart.yaml

@@ -5,16 +5,16 @@ usage: docker compose restart
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: timeout
-    shorthand: t
-    value_type: int
-    default_value: "10"
-    description: Specify a shutdown timeout in seconds
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: timeout
+      shorthand: t
+      value_type: int
+      default_value: "10"
+      description: Specify a shutdown timeout in seconds
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 40 - 40
docs/reference/docker_compose_rm.yaml

@@ -20,46 +20,46 @@ usage: docker compose rm [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: all
-    shorthand: a
-    value_type: bool
-    default_value: "false"
-    description: Deprecated - no effect
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: force
-    shorthand: f
-    value_type: bool
-    default_value: "false"
-    description: Don't ask to confirm removal
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: stop
-    shorthand: s
-    value_type: bool
-    default_value: "false"
-    description: Stop the containers, if required, before removing
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: volumes
-    shorthand: v
-    value_type: bool
-    default_value: "false"
-    description: Remove any anonymous volumes attached to containers
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: all
+      shorthand: a
+      value_type: bool
+      default_value: "false"
+      description: Deprecated - no effect
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: force
+      shorthand: f
+      value_type: bool
+      default_value: "false"
+      description: Don't ask to confirm removal
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: stop
+      shorthand: s
+      value_type: bool
+      default_value: "false"
+      description: Stop the containers, if required, before removing
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: volumes
+      shorthand: v
+      value_type: bool
+      default_value: "false"
+      description: Remove any anonymous volumes attached to containers
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

文件差异内容过多而无法显示
+ 0 - 28
docs/reference/docker_compose_run.yaml


+ 11 - 12
docs/reference/docker_compose_stop.yaml

@@ -1,21 +1,20 @@
 command: docker compose stop
 short: Stop services
-long: Stops running containers without removing them. They can be started again with
-    `docker compose start`.
+long: Stops running containers without removing them. They can be started again with `docker compose start`.
 usage: docker compose stop [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: timeout
-    shorthand: t
-    value_type: int
-    default_value: "10"
-    description: Specify a shutdown timeout in seconds
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+    - option: timeout
+      shorthand: t
+      value_type: int
+      default_value: "10"
+      description: Specify a shutdown timeout in seconds
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

+ 2 - 4
docs/reference/docker_compose_top.yaml

@@ -1,12 +1,10 @@
 command: docker compose top
 short: Display the running processes
 long: Displays the running processes.
-usage: docker compose top
+usage: docker compose top [SERVICES...]
 pname: docker compose
 plink: docker_compose.yaml
-examples: "```\n$ docker compose top\nexample_foo_1\nUID    PID      PPID     C    STIME
-    \  TTY   TIME       CMD\nroot   142353   142331   2    15:33   ?     00:00:00
-    \  ping localhost -c 5 \n```"
+examples: "```\n$ docker compose top\nexample_foo_1\nUID    PID      PPID     C    STIME   TTY   TIME       CMD\nroot   142353   142331   2    15:33   ?     00:00:00   ping localhost -c 5 \n```"
 deprecated: false
 experimental: false
 experimentalcli: false

+ 184 - 188
docs/reference/docker_compose_up.yaml

@@ -1,206 +1,202 @@
 command: docker compose up
 short: Create and start containers
-long: "Builds, (re)creates, starts, and attaches to containers for a service.\n\nUnless
-    they are already running, this command also starts any linked services.\n\nThe
-    `docker compose up` command aggregates the output of each container (liked `docker
-    compose logs --follow` does). \nWhen the command exits, all containers are stopped.
-    Running `docker compose up --detach` starts the containers in the \nbackground
-    and leaves them running.\n\nIf there are existing containers for a service, and
-    the service’s configuration or image was changed after the \ncontainer’s creation,
-    `docker compose up` picks up the changes by stopping and recreating the containers
-    \n(preserving mounted volumes). To prevent Compose from picking up changes, use
-    the `--no-recreate` flag.\n\nIf you want to force Compose to stop and recreate
-    all containers, use the `--force-recreate` flag.\n\nIf the process encounters
-    an error, the exit code for this command is `1`.\nIf the process is interrupted
-    using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit
-    code is `0`."
+long: "Builds, (re)creates, starts, and attaches to containers for a service.\n\nUnless they are already running, this command also starts any linked services.\n\nThe `docker compose up` command aggregates the output of each container (liked `docker compose logs --follow` does). \nWhen the command exits, all containers are stopped. Running `docker compose up --detach` starts the containers in the \nbackground and leaves them running.\n\nIf there are existing containers for a service, and the service’s configuration or image was changed after the \ncontainer’s creation, `docker compose up` picks up the changes by stopping and recreating the containers \n(preserving mounted volumes). To prevent Compose from picking up changes, use the `--no-recreate` flag.\n\nIf you want to force Compose to stop and recreate all containers, use the `--force-recreate` flag.\n\nIf the process encounters an error, the exit code for this command is `1`.\nIf the process is interrupted using `SIGINT` (ctrl + C) or `SIGTERM`, the containers are stopped, and the exit code is `0`."
 usage: docker compose up [SERVICE...]
 pname: docker compose
 plink: docker_compose.yaml
 options:
-  - option: abort-on-container-exit
-    value_type: bool
-    default_value: "false"
-    description: |
+    - option: abort-on-container-exit
+      value_type: bool
+      default_value: "false"
+      description: |
         Stops all containers if any container was stopped. Incompatible with -d
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: always-recreate-deps
-    value_type: bool
-    default_value: "false"
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: always-recreate-deps
+      value_type: bool
+      default_value: "false"
+      description: |
         Recreate dependent containers. Incompatible with --no-recreate.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: attach-dependencies
-    value_type: bool
-    default_value: "false"
-    description: Attach to dependent containers.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: build
-    value_type: bool
-    default_value: "false"
-    description: Build images before starting containers.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: detach
-    shorthand: d
-    value_type: bool
-    default_value: "false"
-    description: 'Detached mode: Run containers in the background'
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: environment
-    shorthand: e
-    value_type: stringArray
-    default_value: '[]'
-    description: Environment variables
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: exit-code-from
-    value_type: string
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: attach
+      value_type: stringArray
+      default_value: '[]'
+      description: Attach to service output.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: attach-dependencies
+      value_type: bool
+      default_value: "false"
+      description: Attach to dependent containers.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: build
+      value_type: bool
+      default_value: "false"
+      description: Build images before starting containers.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: detach
+      shorthand: d
+      value_type: bool
+      default_value: "false"
+      description: 'Detached mode: Run containers in the background'
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: environment
+      shorthand: e
+      value_type: stringArray
+      default_value: '[]'
+      description: Environment variables
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: exit-code-from
+      value_type: string
+      description: |
         Return the exit code of the selected service container. Implies --abort-on-container-exit
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: force-recreate
-    value_type: bool
-    default_value: "false"
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: force-recreate
+      value_type: bool
+      default_value: "false"
+      description: |
         Recreate containers even if their configuration and image haven't changed.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-build
-    value_type: bool
-    default_value: "false"
-    description: Don't build an image, even if it's missing.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-color
-    value_type: bool
-    default_value: "false"
-    description: Produce monochrome output.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-deps
-    value_type: bool
-    default_value: "false"
-    description: Don't start linked services.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-log-prefix
-    value_type: bool
-    default_value: "false"
-    description: Don't print prefix in logs.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-recreate
-    value_type: bool
-    default_value: "false"
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-build
+      value_type: bool
+      default_value: "false"
+      description: Don't build an image, even if it's missing.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-color
+      value_type: bool
+      default_value: "false"
+      description: Produce monochrome output.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-deps
+      value_type: bool
+      default_value: "false"
+      description: Don't start linked services.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-log-prefix
+      value_type: bool
+      default_value: "false"
+      description: Don't print prefix in logs.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-recreate
+      value_type: bool
+      default_value: "false"
+      description: |
         If containers already exist, don't recreate them. Incompatible with --force-recreate.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: no-start
-    value_type: bool
-    default_value: "false"
-    description: Don't start the services after creating them.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: quiet-pull
-    value_type: bool
-    default_value: "false"
-    description: Pull without printing progress information.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: remove-orphans
-    value_type: bool
-    default_value: "false"
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: no-start
+      value_type: bool
+      default_value: "false"
+      description: Don't start the services after creating them.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: quiet-pull
+      value_type: bool
+      default_value: "false"
+      description: Pull without printing progress information.
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: remove-orphans
+      value_type: bool
+      default_value: "false"
+      description: |
         Remove containers for services not defined in the Compose file.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: renew-anon-volumes
-    shorthand: V
-    value_type: bool
-    default_value: "false"
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: renew-anon-volumes
+      shorthand: V
+      value_type: bool
+      default_value: "false"
+      description: |
         Recreate anonymous volumes instead of retrieving data from the previous containers.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: scale
-    value_type: stringArray
-    default_value: '[]'
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: scale
+      value_type: stringArray
+      default_value: '[]'
+      description: |
         Scale SERVICE to NUM instances. Overrides the `scale` setting in the Compose file if present.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
-  - option: timeout
-    shorthand: t
-    value_type: int
-    default_value: "10"
-    description: |
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: timeout
+      shorthand: t
+      value_type: int
+      default_value: "10"
+      description: |
         Use this timeout in seconds for container shutdown when attached or when containers are already running.
-    deprecated: false
-    experimental: false
-    experimentalcli: false
-    kubernetes: false
-    swarm: false
+      deprecated: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 deprecated: false
 experimental: false
 experimentalcli: false

部分文件因为文件数量过多而无法显示