Merge pull request #36 from docker/v0.23.0

Publish v0.23.0 release

dist/docker-scout_0.23.0_checksums.txt

@@ -0,0 +1,6 @@
+4cc65f7867e82cad9dde8f6cf27798915e67d91f06d233f93c19ccca68894273  docker-scout_0.23.0_linux_amd64.tar.gz
+6b6bc4ed5add65ab0be5b154259f920c24d9dd28190304d8b5a467839039f651  docker-scout_0.23.0_darwin_arm64.tar.gz
+74f922ee6d39a83593897ef375245531674033889d23e4e43ef01494ea23d1ed  docker-scout_0.23.0_windows_amd64.zip
+8415aad4f9d2d59260e7e8f4c19fd6a9bc9d59afd8d4461a243e1e5baabb7acb  docker-scout_0.23.0_windows_arm64.zip
+94aa90b387b090c0478b83fc662bb442d78ab5e7462a46219267f845bc9558a7  docker-scout_0.23.0_linux_arm64.tar.gz
+bde48ae80de8867d10740fbe71c55ea022639024fd74ca050ffbee2e515712c8  docker-scout_0.23.0_darwin_amd64.tar.gz

docs/docker_scout.yaml

@@ -5,22 +5,26 @@ usage: docker scout [command]
 pname: docker
 plink: docker.yaml
 cname:
+    - docker scout cache
     - docker scout compare
+    - docker scout config
     - docker scout cves
-    - docker scout push
+    - docker scout environment
+    - docker scout policy
     - docker scout quickview
     - docker scout recommendations
     - docker scout repo
-    - docker scout stream
     - docker scout version
 clink:
+    - docker_scout_cache.yaml
     - docker_scout_compare.yaml
+    - docker_scout_config.yaml
     - docker_scout_cves.yaml
-    - docker_scout_push.yaml
+    - docker_scout_environment.yaml
+    - docker_scout_policy.yaml
     - docker_scout_quickview.yaml
     - docker_scout_recommendations.yaml
     - docker_scout_repo.yaml
-    - docker_scout_stream.yaml
     - docker_scout_version.yaml
 options:
     - option: debug

docs/docker_scout_cache.yaml

@@ -0,0 +1,28 @@
+command: docker scout cache
+short: Manage Docker Scout cache and temporary files
+long: Manage Docker Scout cache and temporary files
+pname: docker scout
+plink: docker_scout.yaml
+cname:
+    - docker scout cache df
+    - docker scout cache prune
+clink:
+    - docker_scout_cache_df.yaml
+    - docker_scout_cache_prune.yaml
+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
+deprecated: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+

docs/docker_scout_cache_df.yaml

@@ -0,0 +1,66 @@
+command: docker scout cache df
+short: Show Docker Scout disk usage
+long: |-
+    Docker Scout stores temporary files to generate SBOMs of images and cache the results to not generate or fetch them again.
+
+    This `docker scout cache df` command will list all the temporary and cached data on the host. Each is identified by the
+    digest of the image.
+
+    Those data can be deleted using the `docker scout cache prune` command.
+usage: docker scout cache df
+pname: docker scout cache
+plink: docker_scout_cache.yaml
+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
+examples: |-
+    ### List temporary and cache files
+
+    ```console
+    $ docker scout cache df
+    Docker Scout temporary directory to generate SBOMs is located at:
+       /var/folders/dw/d6h9w2sx6rv3lzwwgrnx7t5h0000gp/T/docker-scout
+       this path can be configured using the DOCKER_SCOUT_CACHE_DIR environment variable
+
+                                   Image Digest                               │ Size
+    ──────────────────────────────────────────────────────────────────────────┼────────
+      sha256:c41ab5c992deb4fe7e5da09f67a8804a46bd0592bfdf0b1847dde0e0889d2bff │ 21 kB
+
+    Total: 21 kB
+
+
+    Docker Scout cached SBOMs are located at:
+       /Users/user/.docker/scout/sbom
+
+                                   Image Digest                               │ Size of SBOM
+    ──────────────────────────────────────────────────────────────────────────┼───────────────
+      sha256:02bb6f428431fbc2809c5d1b41eab5a68350194fb508869a33cb1af4444c9b11 │ 42 kB
+      sha256:03fc002fe4f370463a8f04d3a288cdffa861e462fc8b5be44ab62b296ad95183 │ 100 kB
+      sha256:088134dd33e4a2997480a1488a41c11abebda465da5cf7f305a0ecf8ed494329 │ 194 kB
+      sha256:0b80b2f17aff7ee5bfb135c69d0d6fe34070e89042b7aac73d1abcc79cfe6759 │ 852 kB
+      sha256:0c9e8abe31a5f17d84d5c85d3853d2f948a4f126421e89e68753591f1b6fedc5 │ 930 kB
+      sha256:0d49cae0723c8d310e413736b5e91e0c59b605ade2546f6e6ef8f1f3ddc76066 │ 510 kB
+      sha256:0ef04748d071c2e631bb3edce8f805cb5512e746b682c83fdae6d8c0b243280b │ 1.0 MB
+      sha256:13fd22925b638bb7d2131914bb8f8b0f5f582bee364aec682d9e7fe722bb486a │ 42 kB
+      sha256:174c41d4fbc7f63e1f2bb7d2f7837318050406f2f27e5073a84a84f18b48b883 │ 115 kB
+
+    Total: 4 MB
+
+
+    What's Next?
+      Delete all cached SBOMs → docker scout prune
+    ```
+deprecated: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+

docs/docker_scout_cache_prune.yaml

@@ -0,0 +1,68 @@
+command: docker scout cache prune
+short: Remove temporary or cached data
+long: |-
+    Docker Scout stores temporary files to generate SBOMs of images and cache those SBOMs to not generate or fetch them again.
+
+    The `docker scout cache prune` command will remove all the temporary files used while generating the SBOMs.
+
+    By default the cached SBOMs will not be deleted are they can be used by the different `docker scout` commands. But the `--sboms`
+    flag can be used to delete them.
+usage: docker scout cache prune
+pname: docker scout cache
+plink: docker_scout_cache.yaml
+options:
+    - option: force
+      shorthand: f
+      value_type: bool
+      default_value: "false"
+      description: Do not prompt for confirmation
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: sboms
+      value_type: bool
+      default_value: "false"
+      description: Prune cached SBOMs
+      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
+examples: |-
+    ### Delete temporary data
+
+    ```console
+    $ docker scout cache prune
+    ? Are you sure to delete all temporary data? Yes
+        ✓ temporary data deleted
+    ```
+
+    ### Delete temporary _and_ cache data
+
+    ```console
+    $ docker scout cache prune --sboms
+    ? Are you sure to delete all temporary data and all cached SBOMs? Yes
+        ✓ temporary data deleted
+        ✓ cached SBOMs deleted
+    ```
+deprecated: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+

docs/docker_scout_compare.yaml

@@ -175,6 +175,15 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: to-env
+      value_type: string
+      description: Name of environment to compare to
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
     - option: to-latest
       value_type: bool
       default_value: "false"
@@ -199,8 +208,8 @@ options:
     - option: to-stream
       value_type: string
       description: Name of stream to compare to
-      deprecated: false
-      hidden: false
+      deprecated: true
+      hidden: true
       experimental: false
       experimentalcli: false
       kubernetes: false

docs/docker_scout_config.yaml

@@ -0,0 +1,48 @@
+command: docker scout config
+short: Manage Docker Scout configuration
+long: |-
+    `docker scout config` allows you to list, get and set Docker Scout configuration.
+
+    Available configuration key:
+    - `organization`: Namespace of the Docker organization to be used by default if it cannot be inferred from the image reference
+usage: docker scout config [KEY] [VALUE]
+pname: docker scout
+plink: docker_scout.yaml
+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
+examples: |-
+    ### List existing configuration
+
+    ```console
+    $ docker scout config
+    organization=my-org-namespace
+    ```
+
+    ### Print configuration value
+
+    ```console
+    $ docker scout config organization
+    my-org-namespace
+    ```
+
+    ### Set configuration value
+
+    ```console
+    $ docker scout config organization my-org-namespace
+        ✓ Successfully set organization to my-org-namespace
+    ```
+deprecated: false
+experimental: false
+experimentalcli: false
+kubernetes: false
+swarm: false
+