docker_scout_environment.yaml

command: docker scout environment
aliases: docker scout environment, docker scout env
short: Manage environments (experimental)
long: |-
    The `docker scout environment` command lists the environments.
    If you pass an image reference, the image is recorded to the specified environment.

    Once recorded, environments can be referred to by their name. For example,
    you can refer to the `production` environment with the `docker scout compare`
    command as follows:

    ```console
    $ docker scout compare --to-env production
    ```
usage: docker scout environment [ENVIRONMENT] [IMAGE]
pname: docker scout
plink: docker_scout.yaml
options:
    - option: org
      value_type: string
      description: Namespace of the Docker organization
      deprecated: false
      hidden: false
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
    - option: output
      shorthand: o
      value_type: string
      description: Write the report to a file
      deprecated: false
      hidden: false
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
    - option: platform
      value_type: string
      description: Platform of image to record
      deprecated: false
      hidden: false
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
inherited_options:
    - option: debug
      value_type: bool
      default_value: "false"
      description: Debug messages
      deprecated: false
      hidden: true
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
    - option: verbose-debug
      value_type: bool
      default_value: "false"
      description: Verbose debug
      deprecated: false
      hidden: true
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
examples: |-
    ### List existing environments

    ```console
    $ docker scout environment
    prod
    staging
    ```

    ### List images of an environment

    ```console
    $ docker scout environment staging
    namespace/repo:tag@sha256:9a4df4fadc9bbd44c345e473e0688c2066a6583d4741679494ba9228cfd93e1b
    namespace/other-repo:tag@sha256:0001d6ce124855b0a158569c584162097fe0ca8d72519067c2c8e3ce407c580f
    ```

    ### Record an image to an environment, for a specific platform

    ```console
    $ docker scout environment staging namespace/repo:stage-latest --platform linux/amd64
    ✓ Pulled
    ✓ Successfully recorded namespace/repo:stage-latest in environment staging
    ```
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false