Files
docker-docs/data/scout-cli/docker_scout_cache_prune.yaml
David Karlsson ec72262eed scout: remove module for cli docs, vendor manually
Upstream docs had a formatting issue that needed a hotfix.
Rather than fixing the vendored yaml,
which would be overwritten the next time update (any) vendored modules,
I decided to manually copy the cli reference yaml to the data dir.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-01-05 09:18:29 +01:00

77 lines
1.9 KiB
YAML
Generated

command: docker scout cache prune
short: Remove temporary or cached data
long: |-
The `docker scout cache prune` command removes temporary data and SBOM cache.
By default, `docker scout cache prune` only deletes temporary data.
To delete temporary data and clear the SBOM cache, use the `--sboms` flag.
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
- 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: |-
### 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