Skip to content

Commit 5656c98

Browse files
crazy-maxcrazy-max
authored
Merge pull request #2565 from dvdksn/cli-docs-tool-v0.8.0
cli docs tool v0.8.0
2 parents 7b80ad7 + 263a9dd commit 5656c98

39 files changed

+9735
-106
lines changed

‎docs/reference/buildx_bake.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,14 @@ Build from a file
1717
|:------------------------------------|:--------------|:--------|:----------------------------------------------------------------------------------------------------|
1818
| [`--builder`](#builder) | `string` | | Override the configured builder instance |
1919
| [`-f`](#file), [`--file`](#file) | `stringArray` | | Build definition file |
20-
| `--load` | | | Shorthand for `--set=*.output=type=docker` |
20+
| `--load` | `bool` | | Shorthand for `--set=*.output=type=docker` |
2121
| [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to a file |
22-
| [`--no-cache`](#no-cache) | | | Do not use cache when building the image |
23-
| [`--print`](#print) | | | Print the options without building |
22+
| [`--no-cache`](#no-cache) | `bool` | | Do not use cache when building the image |
23+
| [`--print`](#print) | `bool` | | Print the options without building |
2424
| [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output |
2525
| [`--provenance`](#provenance) | `string` | | Shorthand for `--set=*.attest=type=provenance` |
26-
| [`--pull`](#pull) | | | Always attempt to pull all referenced images |
27-
| `--push` | | | Shorthand for `--set=*.output=type=registry` |
26+
| [`--pull`](#pull) | `bool` | | Always attempt to pull all referenced images |
27+
| `--push` | `bool` | | Shorthand for `--set=*.output=type=registry` |
2828
| [`--sbom`](#sbom) | `string` | | Shorthand for `--set=*.attest=type=sbom` |
2929
| [`--set`](#set) | `stringArray` | | Override target value (e.g., `targetpattern.key=value`) |
3030

‎docs/reference/buildx_build.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,23 @@ Start a build
2626
| [`--cache-to`](#cache-to) | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) |
2727
| `--call` | `string` | `build` | Set method for evaluating build (`check`, `outline`, `targets`) |
2828
| [`--cgroup-parent`](#cgroup-parent) | `string` | | Set the parent cgroup for the `RUN` instructions during build |
29-
| `--check` | | | Shorthand for `--call=check` |
30-
| `--detach` | | | Detach buildx server (supported only on linux) (EXPERIMENTAL) |
29+
| `--check` | `bool` | | Shorthand for `--call=check` |
30+
| `--detach` | `bool` | | Detach buildx server (supported only on linux) (EXPERIMENTAL) |
3131
| [`-f`](#file), [`--file`](#file) | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) |
3232
| `--iidfile` | `string` | | Write the image ID to a file |
3333
| `--label` | `stringArray` | | Set metadata for an image |
34-
| [`--load`](#load) | | | Shorthand for `--output=type=docker` |
34+
| [`--load`](#load) | `bool` | | Shorthand for `--output=type=docker` |
3535
| [`--metadata-file`](#metadata-file) | `string` | | Write build result metadata to a file |
3636
| [`--network`](#network) | `string` | `default` | Set the networking mode for the `RUN` instructions during build |
37-
| `--no-cache` | | | Do not use cache when building the image |
37+
| `--no-cache` | `bool` | | Do not use cache when building the image |
3838
| [`--no-cache-filter`](#no-cache-filter) | `stringArray` | | Do not cache specified stages |
3939
| [`-o`](#output), [`--output`](#output) | `stringArray` | | Output destination (format: `type=local,dest=path`) |
4040
| [`--platform`](#platform) | `stringArray` | | Set target platform for build |
4141
| [`--progress`](#progress) | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output |
4242
| [`--provenance`](#provenance) | `string` | | Shorthand for `--attest=type=provenance` |
43-
| `--pull` | | | Always attempt to pull all referenced images |
44-
| [`--push`](#push) | | | Shorthand for `--output=type=registry` |
45-
| `-q`, `--quiet` | | | Suppress the build output and print image ID on success |
43+
| `--pull` | `bool` | | Always attempt to pull all referenced images |
44+
| [`--push`](#push) | `bool` | | Shorthand for `--output=type=registry` |
45+
| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success |
4646
| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) |
4747
| [`--sbom`](#sbom) | `string` | | Shorthand for `--attest=type=sbom` |
4848
| [`--secret`](#secret) | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) |

‎docs/reference/buildx_create.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,17 @@ Create a new builder instance
1111

1212
| Name | Type | Default | Description |
1313
|:------------------------------------------|:--------------|:--------|:----------------------------------------------------------------------|
14-
| [`--append`](#append) | | | Append a node to builder instead of changing it |
15-
| `--bootstrap` | | | Boot builder after creation |
14+
| [`--append`](#append) | `bool` | | Append a node to builder instead of changing it |
15+
| `--bootstrap` | `bool` | | Boot builder after creation |
1616
| [`--buildkitd-config`](#buildkitd-config) | `string` | | BuildKit daemon config file |
1717
| [`--buildkitd-flags`](#buildkitd-flags) | `string` | | BuildKit daemon flags |
1818
| [`--driver`](#driver) | `string` | | Driver to use (available: `docker-container`, `kubernetes`, `remote`) |
1919
| [`--driver-opt`](#driver-opt) | `stringArray` | | Options for the driver |
20-
| [`--leave`](#leave) | | | Remove a node from builder instead of changing it |
20+
| [`--leave`](#leave) | `bool` | | Remove a node from builder instead of changing it |
2121
| [`--name`](#name) | `string` | | Builder instance name |
2222
| [`--node`](#node) | `string` | | Create/modify node with given name |
2323
| [`--platform`](#platform) | `stringArray` | | Fixed platforms for current node |
24-
| [`--use`](#use) | | | Set the current builder instance |
24+
| [`--use`](#use) | `bool` | | Set the current builder instance |
2525

2626

2727
<!---MARKER_GEN_END-->

‎docs/reference/buildx_debug_build.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,23 @@ Start a build
2222
| `--cache-to` | `stringArray` | | Cache export destinations (e.g., `user/app:cache`, `type=local,dest=path/to/dir`) |
2323
| `--call` | `string` | `build` | Set method for evaluating build (`check`, `outline`, `targets`) |
2424
| `--cgroup-parent` | `string` | | Set the parent cgroup for the `RUN` instructions during build |
25-
| `--check` | | | Shorthand for `--call=check` |
26-
| `--detach` | | | Detach buildx server (supported only on linux) (EXPERIMENTAL) |
25+
| `--check` | `bool` | | Shorthand for `--call=check` |
26+
| `--detach` | `bool` | | Detach buildx server (supported only on linux) (EXPERIMENTAL) |
2727
| `-f`, `--file` | `string` | | Name of the Dockerfile (default: `PATH/Dockerfile`) |
2828
| `--iidfile` | `string` | | Write the image ID to a file |
2929
| `--label` | `stringArray` | | Set metadata for an image |
30-
| `--load` | | | Shorthand for `--output=type=docker` |
30+
| `--load` | `bool` | | Shorthand for `--output=type=docker` |
3131
| `--metadata-file` | `string` | | Write build result metadata to a file |
3232
| `--network` | `string` | `default` | Set the networking mode for the `RUN` instructions during build |
33-
| `--no-cache` | | | Do not use cache when building the image |
33+
| `--no-cache` | `bool` | | Do not use cache when building the image |
3434
| `--no-cache-filter` | `stringArray` | | Do not cache specified stages |
3535
| `-o`, `--output` | `stringArray` | | Output destination (format: `type=local,dest=path`) |
3636
| `--platform` | `stringArray` | | Set target platform for build |
3737
| `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output |
3838
| `--provenance` | `string` | | Shorthand for `--attest=type=provenance` |
39-
| `--pull` | | | Always attempt to pull all referenced images |
40-
| `--push` | | | Shorthand for `--output=type=registry` |
41-
| `-q`, `--quiet` | | | Suppress the build output and print image ID on success |
39+
| `--pull` | `bool` | | Always attempt to pull all referenced images |
40+
| `--push` | `bool` | | Shorthand for `--output=type=registry` |
41+
| `-q`, `--quiet` | `bool` | | Suppress the build output and print image ID on success |
4242
| `--root` | `string` | | Specify root directory of server to connect (EXPERIMENTAL) |
4343
| `--sbom` | `string` | | Shorthand for `--attest=type=sbom` |
4444
| `--secret` | `stringArray` | | Secret to expose to the build (format: `id=mysecret[,src=/local/secret]`) |

‎docs/reference/buildx_du.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Disk usage
1313
|:------------------------|:---------|:--------|:-----------------------------------------|
1414
| [`--builder`](#builder) | `string` | | Override the configured builder instance |
1515
| `--filter` | `filter` | | Provide filter values |
16-
| [`--verbose`](#verbose) | | | Provide a more verbose output |
16+
| [`--verbose`](#verbose) | `bool` | | Provide a more verbose output |
1717

1818

1919
<!---MARKER_GEN_END-->

‎docs/reference/buildx_imagetools_create.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Create a new image based on source images
1212
| Name | Type | Default | Description |
1313
|:---------------------------------|:--------------|:--------|:------------------------------------------------------------------------------------------------------------------------------|
1414
| [`--annotation`](#annotation) | `stringArray` | | Add annotation to the image |
15-
| [`--append`](#append) | | | Append to existing manifest |
15+
| [`--append`](#append) | `bool` | | Append to existing manifest |
1616
| [`--builder`](#builder) | `string` | | Override the configured builder instance |
17-
| [`--dry-run`](#dry-run) | | | Show final image instead of pushing |
17+
| [`--dry-run`](#dry-run) | `bool` | | Show final image instead of pushing |
1818
| [`-f`](#file), [`--file`](#file) | `stringArray` | | Read source descriptor from file |
1919
| `--prefer-index` | `bool` | `true` | When only a single source is specified, prefer outputting an image index or manifest list instead of performing a carbon copy |
2020
| `--progress` | `string` | `auto` | Set type of progress output (`auto`, `plain`, `tty`, `rawjson`). Use plain to show container output |

‎docs/reference/buildx_imagetools_inspect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Show details of an image in the registry
1313
|:------------------------|:---------|:----------------|:----------------------------------------------|
1414
| [`--builder`](#builder) | `string` | | Override the configured builder instance |
1515
| [`--format`](#format) | `string` | `{{.Manifest}}` | Format the output using the given Go template |
16-
| [`--raw`](#raw) | | | Show original, unformatted JSON manifest |
16+
| [`--raw`](#raw) | `bool` | | Show original, unformatted JSON manifest |
1717

1818

1919
<!---MARKER_GEN_END-->

‎docs/reference/buildx_inspect.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Inspect current builder instance
1111

1212
| Name | Type | Default | Description |
1313
|:----------------------------|:---------|:--------|:--------------------------------------------|
14-
| [`--bootstrap`](#bootstrap) | | | Ensure builder has booted before inspecting |
14+
| [`--bootstrap`](#bootstrap) | `bool` | | Ensure builder has booted before inspecting |
1515
| [`--builder`](#builder) | `string` | | Override the configured builder instance |
1616

1717

0 commit comments

Comments
 (0)