mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
eb8fa131d6
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
218 lines
7.3 KiB
YAML
Generated
218 lines
7.3 KiB
YAML
Generated
command: docker buildx prune
|
|
short: Remove build cache
|
|
long: Clears the build cache of the selected builder.
|
|
usage: docker buildx prune
|
|
pname: docker buildx
|
|
plink: docker_buildx.yaml
|
|
options:
|
|
- option: all
|
|
shorthand: a
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Include internal/frontend images
|
|
details_url: '#all'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: filter
|
|
value_type: filter
|
|
description: Provide filter values
|
|
details_url: '#filter'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- 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: keep-storage
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Amount of disk space to keep for cache
|
|
deprecated: true
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: max-used-space
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Maximum amount of disk space allowed to keep for cache
|
|
details_url: '#max-used-space'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: min-free-space
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Target amount of free disk space after pruning
|
|
details_url: '#min-free-space'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: reserved-space
|
|
value_type: bytes
|
|
default_value: "0"
|
|
description: Amount of disk space always allowed to keep for cache
|
|
details_url: '#reserved-space'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: timeout
|
|
value_type: duration
|
|
default_value: 20s
|
|
description: Override the default timeout for loading builder status
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: verbose
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Provide a more verbose output
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
inherited_options:
|
|
- option: builder
|
|
value_type: string
|
|
description: Override the configured builder instance
|
|
details_url: '#builder'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: debug
|
|
shorthand: D
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Enable debug logging
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
examples: |-
|
|
### Include internal/frontend images (--all) {#all}
|
|
|
|
The `--all` flag to allow clearing internal helper images and frontend images
|
|
set using the `#syntax=` directive or the `BUILDKIT_SYNTAX` build argument.
|
|
|
|
### Provide filter values (--filter) {#filter}
|
|
|
|
You can finely control which cache records to delete using the `--filter` flag.
|
|
|
|
The filter format is in the form of `<key><op><value>`, known as selectors. All
|
|
selectors must match the target object for the filter to be true. We define the
|
|
operators `=` for equality, `!=` for not equal and `~=` for a regular
|
|
expression.
|
|
|
|
Valid filter keys are:
|
|
- `until` flag to keep records that have been used in the last duration time.
|
|
Value is a duration string, e.g. `24h` or `2h30m`, with allowable units of
|
|
`(h)ours`, `(m)inutes` and `(s)econds`.
|
|
- `id` flag to target a specific image ID.
|
|
- `parents` flag to target records that are parents of the
|
|
specified image ID. Multiple parent IDs are separated by a semicolon (`;`).
|
|
- `description` flag to target records whose description is the specified
|
|
substring.
|
|
- `inuse` flag to target records that are actively in use and therefore not
|
|
reclaimable.
|
|
- `mutable` flag to target records that are mutable.
|
|
- `immutable` flag to target records that are immutable.
|
|
- `shared` flag to target records that are shared with other resources,
|
|
typically images.
|
|
- `private` flag to target records that are not shared.
|
|
- `type` flag to target records by type. Valid types are:
|
|
- `internal`
|
|
- `frontend`
|
|
- `source.local`
|
|
- `source.git.checkout`
|
|
- `exec.cachemount`
|
|
- `regular`
|
|
|
|
Examples:
|
|
|
|
```console
|
|
docker buildx prune --filter "until=24h"
|
|
docker buildx prune --filter "description~=golang"
|
|
docker buildx prune --filter "parents=dpetmoi6n0yqanxjqrbnofz9n;kgoj0q6g57i35gdyrv546alz7"
|
|
docker buildx prune --filter "type=source.local"
|
|
docker buildx prune --filter "type!=exec.cachemount"
|
|
```
|
|
|
|
> [!NOTE]
|
|
> Multiple `--filter` flags are ANDed together.
|
|
|
|
### Maximum amount of disk space allowed to keep for cache (--max-used-space) {#max-used-space}
|
|
|
|
The `--max-used-space` flag allows setting a maximum amount of disk space
|
|
that the build cache can use. If the cache is using more disk space than this
|
|
value, the least recently used cache records are deleted until the total
|
|
used space is less than or equal to the specified value.
|
|
|
|
The value is specified in bytes. You can use a human-readable memory string,
|
|
e.g. `128mb`, `2gb`, etc. Units are case-insensitive.
|
|
|
|
### Target amount of free disk space after pruning (--min-free-space) {#min-free-space}
|
|
|
|
The `--min-free-space` flag allows setting a target amount of free disk space
|
|
that should be available after pruning. If the available disk space is less
|
|
than this value, the least recently used cache records are deleted until
|
|
the available free space is greater than or equal to the specified value.
|
|
|
|
The value is specified in bytes. You can use a human-readable memory string,
|
|
e.g. `128mb`, `2gb`, etc. Units are case-insensitive.
|
|
|
|
### Amount of disk space always allowed to keep for cache (--reserved-space) {#reserved-space}
|
|
|
|
The `--reserved-space` flag allows setting an amount of disk space that
|
|
should always be kept for the build cache. If the available disk space is less
|
|
than this value, the least recently used cache records are deleted until
|
|
the available free space is greater than or equal to the specified value.
|
|
|
|
The value is specified in bytes. You can use a human-readable memory string,
|
|
e.g. `128mb`, `2gb`, etc. Units are case-insensitive.
|
|
|
|
### Override the configured builder instance (--builder) {#builder}
|
|
|
|
Same as [`buildx --builder`](/reference/cli/docker/buildx/#builder).
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|