feedback + updated examples + added links for h3 headings

Signed-off-by: sarahsanders-docker <sarah.sanders@docker.com>
This commit is contained in:
sarahsanders-docker
2025-04-22 12:14:51 -04:00
committed by Tonis Tiigi
parent 4dac5295a1
commit 23ce21c341
10 changed files with 300 additions and 58 deletions

View File

@@ -20,45 +20,81 @@ List build records
## Description
List completed builds recorded by the active builder. Each entry includes the
build ID, name (if available), status, timestamp, and duration.
build ID, name, status, timestamp, and duration.
By default, only records for the current builder are shown. You can filter
results using flags.
## Examples
### List all build records for the current builder
### <a name="list-build-records-current"></a> List all build records for the current builder
```console
docker buildx history ls
$ docker buildx history ls
BUILD ID NAME STATUS CREATED AT DURATION
qu2gsuo8ejqrwdfii23xkkckt .dev/2850 Completed 3 days ago 1.4s
qsiifiuf1ad9pa9qvppc0z1l3 .dev/2850 Completed 3 days ago 1.3s
g9808bwrjrlkbhdamxklx660b .dev/3120 Completed 5 days ago 2.1s
```
### List only failed builds
### <a name="list-failed-builds"></a> List only failed builds
```console
docker buildx history ls --filter status=error
```
### List builds from the current directory
You can filter the list using the `--filter` flag. Supported filters include:
| Filter | Supported comparisons | Example |
|:-------|:----------------------|:--------|
| `ref`, `repository`, `status` | Support `=` and `!=` comparisons | `--filter status!=success` |
| `startedAt`, `completedAt`, `duration` | Support `<` and `>` comparisons with time values | `--filter duration>30s` |
You can combine multiple filters by repeating the `--filter` flag:
```console
docker buildx history ls --filter status=error --filter duration>30s
```
### <a name="list-builds-current-project"></a> List builds from the current project
```console
docker buildx history ls --local
```
### Display full output without truncation
### <a name="display-full-output"></a> Display full output without truncation
```console
docker buildx history ls --no-trunc
```
### Format output as JSON
### <a name="list-as-json"></a> Format output as JSON
```console
docker buildx history ls --format json
$ docker buildx history ls --format json
[
{
"ID": "qu2gsuo8ejqrwdfii23xkkckt",
"Name": ".dev/2850",
"Status": "Completed",
"CreatedAt": "2025-04-15T12:33:00Z",
"Duration": "1.4s"
},
{
"ID": "qsiifiuf1ad9pa9qvppc0z1l3",
"Name": ".dev/2850",
"Status": "Completed",
"CreatedAt": "2025-04-15T12:29:00Z",
"Duration": "1.3s"
}
]
```
### Use a Go template to print name and durations
### <a name="list-go-template"></a> Use a Go template to print name and durations
```console
docker buildx history ls --format '{{.Name}} - {{.Duration}}'
$ docker buildx history ls --format '{{.Name}} - {{.Duration}}'
.dev/2850 - 1.4s
.dev/2850 - 1.3s
.dev/3120 - 2.1s
```