Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit d1bb93f

Browse files
committedMay 19, 2024·
chore: synchronize text from CLI for subcommands
Signed-off-by: Terry Howe <terrylhowe@gmail.com>
1 parent a8285c6 commit d1bb93f

9 files changed

+49
-59
lines changed
 

‎docs/commands/oras_blob_delete.mdx

+4-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 20
55

66
# oras blob delete
77

8-
Delete a blob from a remote registry.
8+
Delete a blob from a remote registry
99

1010
```bash
1111
oras blob delete [flags] <name>@<digest>
@@ -22,14 +22,14 @@ oras blob delete localhost:5000/hello@sha256:9a201d228ebd966211f7d1131be19f152be
2222
Delete a blob without prompting confirmation:
2323

2424
```bash
25-
oras blob delete --yes localhost:5000/hello@sha256:9a201d228ebd966211f7d1131be19f152be428bd373a92071c71d8deaf83b3e5
25+
oras blob delete --force localhost:5000/hello@sha256:9a201d228ebd966211f7d1131be19f152be428bd373a92071c71d8deaf83b3e5
2626
```
2727

2828
Delete a blob and print its descriptor:
2929

3030
```bash
31-
oras blob delete --descriptor --yes localhost:5000/hello@sha256:9a201d228ebd966211f7d1131be19f152be428bd373a92071c71d8deaf83b3e5
32-
```
31+
oras blob delete --descriptor --force localhost:5000/hello@sha256:9a201d228ebd966211f7d1131be19f152be428bd373a92071c71d8deaf83b3e5
32+
```
3333

3434
## Options
3535

@@ -50,4 +50,3 @@ oras blob delete --descriptor --yes localhost:5000/hello@sha256:9a201d228ebd9662
5050
-u, --username string registry username
5151
-v, --verbose verbose output
5252
```
53-

‎docs/commands/oras_blob_fetch.mdx

+1-9
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_position: 30
55

66
# oras blob fetch
77

8-
Fetch a blob from a remote registry.
8+
Fetch a blob from a registry or an OCI image layout
99

1010
```bash
1111
oras blob fetch [flags] {--output <file> | --descriptor} <name>@<digest>
@@ -49,14 +49,6 @@ Fetch and print a blob from OCI image layout archive file 'layout.tar':
4949
oras blob fetch --oci-layout --output - layout.tar@sha256:9a201d228ebd966211f7d1131be19f152be428bd373a92071c71d8deaf83b3e5
5050
```
5151

52-
Fetch a blob with a specific reference, determine its size using `jq`, and use `pv` to display the progress while redirecting the output to a file named `layer.bin`:
53-
54-
```bash
55-
$blob_ref=ghcr.io/oras-project/oras@sha256:74529e03eae02d1fff5c05e9a6ec2089e1f5ae96421169c29a7c165346e042e4
56-
$size=$(oras blob fetch --descriptor $blob_ref | jq -r .size)
57-
$oras blob fetch $blob_ref --output - | pv -s $size > layer.bin
58-
```
59-
6052
## Options
6153

6254
```

‎docs/commands/oras_blob_push.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,21 @@ sidebar_position: 40
55

66
# oras blob push
77

8-
Push a blob to a remote registry.
8+
Push a blob to a registry or an OCI image layout
99

1010
```bash
1111
oras blob push [flags] <name>[@digest] <file>
1212
```
1313

1414
## Examples
1515

16-
Push blob "hi.txt":
16+
Push blob 'hi.txt' to a registry:
1717

1818
```bash
1919
oras blob push localhost:5000/hello hi.txt
2020
```
2121

22-
Push blob "hi.txt" with the specific digest:
22+
Push blob 'hi.txt' with the specific digest:
2323

2424
```bash
2525
oras blob push localhost:5000/hello@sha256:9a201d228ebd966211f7d1131be19f152be428bd373a92071c71d8deaf83b3e5 hi.txt
@@ -31,19 +31,19 @@ Push blob from stdin with blob size and digest:
3131
oras blob push --size 12 localhost:5000/hello@sha256:9a201d228ebd966211f7d1131be19f152be428bd373a92071c71d8deaf83b3e5 -
3232
```
3333

34-
Push blob "hi.txt" and output the descriptor:
34+
Push blob 'hi.txt' and output the descriptor:
3535

3636
```bash
3737
oras blob push --descriptor localhost:5000/hello hi.txt
3838
```
3939

40-
Push blob "hi.txt" with the specific returned media type in the descriptor:
40+
Push blob 'hi.txt' with the specific returned media type in the descriptor:
4141

4242
```bash
4343
oras blob push --media-type application/vnd.oci.image.config.v1+json --descriptor localhost:5000/hello hi.txt
4444
```
4545

46-
Push blob "hi.txt" and output the prettified descriptor:
46+
Push blob 'hi.txt' and output the prettified descriptor:
4747

4848
```bash
4949
oras blob push --descriptor --pretty localhost:5000/hello hi.txt
@@ -55,7 +55,7 @@ Push blob without TLS:
5555
oras blob push --insecure localhost:5000/hello hi.txt
5656
```
5757

58-
Push blob 'hi.txt' into an OCI layout folder 'layout-dir':
58+
Push blob 'hi.txt' into an OCI image layout folder 'layout-dir':
5959

6060
```bash
6161
oras blob push --oci-layout layout-dir hi.txt

‎docs/commands/oras_manifest_delete.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: oras manifest delete
3-
sidebar_position: 90
3+
sidebar_position: 140
44
---
55

66
# oras manifest delete
77

8-
Delete a manifest from remote registry.
8+
Delete a manifest from remote registry
99

1010
```bash
1111
oras manifest delete [flags] <name>{:<tag>|@<digest>}
@@ -16,25 +16,25 @@ oras manifest delete [flags] <name>{:<tag>|@<digest>}
1616
Delete a manifest tagged with 'v1' from repository 'localhost:5000/hello':
1717

1818
```bash
19-
oras manifest delete localhost:5000/hello:v1
19+
oras manifest delete localhost:5000/hello:v1
2020
```
2121

2222
Delete a manifest without prompting confirmation:
2323

2424
```bash
25-
oras manifest delete --force localhost:5000/hello:v1
25+
oras manifest delete --force localhost:5000/hello:v1
2626
```
2727

2828
Delete a manifest and print its descriptor:
2929

3030
```bash
31-
oras manifest delete --descriptor localhost:5000/hello:v1
31+
oras manifest delete --descriptor localhost:5000/hello:v1
3232
```
3333

3434
Delete a manifest by digest 'sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9' from repository 'localhost:5000/hello':
3535

3636
```bash
37-
oras manifest delete localhost:5000/hello@sha:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9
37+
oras manifest delete localhost:5000/hello@sha:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64fdee971359a77073cdf9
3838
```
3939

4040
## Options
@@ -56,4 +56,4 @@ Delete a manifest by digest 'sha256:99e4703fbf30916f549cd6bfa9cdbab614b5392fbe64
5656
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
5757
-u, --username string registry username
5858
-v, --verbose verbose output
59-
```
59+
```

‎docs/commands/oras_manifest_fetch-config.mdx

+5-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: oras manifest fetch-config
3-
sidebar_position: 100
3+
sidebar_position: 160
44
---
55

66
# oras manifest fetch-config
77

8-
Fetch the config of a manifest from a remote registry.
8+
Fetch the config of a manifest from a registry or an OCI image layout
99

1010
```bash
1111
oras manifest fetch-config [flags] <name>{:<tag>|@<digest>}
@@ -49,19 +49,17 @@ Fetch and print the prettified descriptor of the config:
4949
oras manifest fetch-config --descriptor --pretty localhost:5000/hello:v1
5050
```
5151

52-
5352
## Options
5453

5554
```
5655
--ca-file string server certificate authority file for the remote registry
5756
-d, --debug debug mode
5857
--descriptor output the descriptor
5958
-H, --header stringArray add custom headers to requests
60-
-h, --help help for fetch
59+
-h, --help help for fetch-config
6160
--insecure allow connections to SSL registry without certs
62-
--media-type strings accepted media types
6361
--oci-layout set target as an OCI image layout
64-
-o, --output path file path to write the fetched manifest to, use - for stdout
62+
-o, --output path file path to write the fetched config to, use - for stdout
6563
-p, --password string registry password or identity token
6664
--password-stdin read password or identity token from stdin
6765
--plain-http allow insecure connections to registry without SSL check
@@ -71,4 +69,4 @@ oras manifest fetch-config --descriptor --pretty localhost:5000/hello:v1
7169
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
7270
-u, --username string registry username
7371
-v, --verbose verbose output
74-
```
72+
```

‎docs/commands/oras_manifest_fetch.mdx

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: oras manifest fetch
3-
sidebar_position: 110
3+
sidebar_position: 150
44
---
55

66
# oras manifest fetch
77

8-
Fetch manifest of the target artifact.
8+
Fetch manifest of the target artifact
99

1010
```bash
1111
oras manifest fetch [flags] <name>{:<tag>|@<digest>}
@@ -43,7 +43,7 @@ Fetch manifest from a registry with prettified json result:
4343
oras manifest fetch --pretty localhost:5000/hello:v1
4444
```
4545

46-
Fetch raw manifest from an OCI layout folder 'layout-dir':
46+
Fetch raw manifest from an OCI image layout folder 'layout-dir':
4747

4848
```bash
4949
oras manifest fetch --oci-layout layout-dir:v1
@@ -61,18 +61,19 @@ oras manifest fetch --oci-layout layout.tar:v1
6161
--ca-file string server certificate authority file for the remote registry
6262
-d, --debug debug mode
6363
--descriptor output the descriptor
64+
-H, --header stringArray add custom headers to requests
6465
-h, --help help for fetch
6566
--insecure allow connections to SSL registry without certs
6667
--media-type strings accepted media types
67-
--oci-layout set target as an OCI image layout.
68+
--oci-layout set target as an OCI image layout
6869
-o, --output path file path to write the fetched manifest to, use - for stdout
6970
-p, --password string registry password or identity token
7071
--password-stdin read password or identity token from stdin
7172
--plain-http allow insecure connections to registry without SSL check
7273
--platform os[/arch][/variant][:os_version] request platform in the form of os[/arch][/variant][:os_version]
7374
--pretty prettify JSON objects printed to stdout
74-
--registry-config path path of the authentication file
75-
--resolve host:port:address customized DNS formatted in host:port:address
75+
--registry-config path path of the authentication file for registry
76+
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
7677
-u, --username string registry username
7778
-v, --verbose verbose output
78-
```
79+
```

‎docs/commands/oras_manifest_push.mdx

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: oras manifest push
3-
sidebar_position: 120
3+
sidebar_position: 170
44
---
55

66
# oras manifest push
77

8-
Push a manifest to remote registry.
8+
Push a manifest to a registry or an OCI image layout
99

1010
```bash
1111
oras manifest push [flags] <name>[:<tag>[,<tag>][...]|@<digest>] <file>
@@ -62,7 +62,7 @@ Push a manifest to repository 'localhost:5000/hello' and tag with 'tag1', 'tag2'
6262
oras manifest push --concurrency 6 localhost:5000/hello:tag1,tag2,tag3 manifest.json
6363
```
6464

65-
Push a manifest to an OCI layout folder 'layout-dir' and tag with 'v1':
65+
Push a manifest to an OCI image layout folder 'layout-dir' and tag with 'v1':
6666

6767
```bash
6868
oras manifest push --oci-layout layout-dir:v1 manifest.json
@@ -89,4 +89,4 @@ oras manifest push --oci-layout layout-dir:v1 manifest.json
8989
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
9090
-u, --username string registry username
9191
-v, --verbose verbose output
92-
```
92+
```

‎docs/commands/oras_repo_ls.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
---
22
title: oras repo ls
3-
sidebar_position: 150
3+
sidebar_position: 200
44
---
55

66
# oras repo ls
77

8-
List the repositories under the registry.
8+
List the repositories under the registry
99

1010
```bash
1111
oras repo ls [flags] <registry>
1212
```
1313

1414
## Examples
1515

16-
Example - List the repositories under the registry:
16+
List the repositories under the registry:
1717

1818
```bash
1919
oras repo ls localhost:5000
2020
```
2121

22-
Example - List the repositories under a namespace in the registry:
22+
List the repositories under a namespace in the registry:
2323

2424
```bash
2525
oras repo ls localhost:5000/example-namespace
2626
```
2727

28-
Example - List the repositories under the registry that include values lexically after last:
28+
List the repositories under the registry that include values lexically after last:
2929

3030
```bash
3131
oras repo ls --last "last_repo" localhost:5000
3232
```
3333

3434
## Options
3535

36-
```bash
36+
```
3737
--ca-file string server certificate authority file for the remote registry
3838
-d, --debug debug mode
3939
-H, --header stringArray add custom headers to requests
@@ -47,4 +47,4 @@ oras repo ls --last "last_repo" localhost:5000
4747
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
4848
-u, --username string registry username
4949
-v, --verbose verbose output
50-
```
50+
```

‎docs/commands/oras_repo_tags.mdx

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: oras repo tags
3-
sidebar_position: 160
3+
sidebar_position: 210
44
---
55

66
# oras repo tags
77

8-
Show tags of the target repository.
8+
Show tags of the target repository
99

1010
```bash
1111
oras repo tags [flags] <name>
@@ -31,7 +31,7 @@ Show tags of the target repository that include values lexically after last:
3131
oras repo tags --last "last_tag" localhost:5000/hello
3232
```
3333

34-
Show tags of the target OCI layout folder 'layout-dir':
34+
Show tags of the target OCI image layout folder 'layout-dir':
3535

3636
```bash
3737
oras repo tags --oci-layout layout-dir
@@ -43,13 +43,13 @@ Show tags of the target OCI layout archive 'layout.tar':
4343
oras repo tags --oci-layout layout.tar
4444
```
4545

46-
Show tags associated with a particular tagged resource:
46+
[Experimental] Show tags associated with a particular tagged resource:
4747

4848
```bash
4949
oras repo tags localhost:5000/hello:latest
5050
```
5151

52-
Show tags associated with a digest:
52+
[Experimental] Show tags associated with a digest:
5353

5454
```bash
5555
oras repo tags localhost:5000/hello@sha256:c551125a624189cece9135981621f3f3144564ddabe14b523507bf74c2281d9b
@@ -73,4 +73,4 @@ oras repo tags localhost:5000/hello@sha256:c551125a624189cece9135981621f3f314456
7373
--resolve host:port:address[:address_port] customized DNS for registry, formatted in host:port:address[:address_port]
7474
-u, --username string registry username
7575
-v, --verbose verbose output
76-
```
76+
```

0 commit comments

Comments
 (0)
Please sign in to comment.