Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve --platform documentation to better explain its usage format #598

Closed
lizMSFT opened this issue Sep 22, 2022 · 1 comment · Fixed by #606
Closed

Improve --platform documentation to better explain its usage format #598

lizMSFT opened this issue Sep 22, 2022 · 1 comment · Fixed by #606
Assignees
Labels
ux User experience related
Milestone

Comments

@lizMSFT
Copy link
Contributor

lizMSFT commented Sep 22, 2022

Current documentation:

$ oras manifest fetch -h
[Preview] Fetch manifest of the target artifact

** This command is in preview and under development. **

Example - Fetch raw manifest:
  oras manifest fetch localhost:5000/hello:latest

Example - Fetch the descriptor of a manifest:
  oras manifest fetch --descriptor localhost:5000/hello:latest

Example - Fetch manifest with specified media type:
  oras manifest fetch --media-type 'application/vnd.oci.image.manifest.v1+json' localhost:5000/hello:latest

Example - Fetch manifest with certain platform:
  oras manifest fetch --platform 'linux/arm/v5' localhost:5000/hello:latest

Example - Fetch manifest with prettified json result:
  oras manifest fetch --pretty localhost:5000/hello:latest

Usage:
  oras manifest fetch [flags] <name:tag|name@digest>

Aliases:
  fetch, get

Flags:
      --ca-file string                server certificate authority file for the remote registry
  -d, --debug                         debug mode
      --descriptor                    output the descriptor
  -h, --help                          help for fetch
      --insecure                      allow connections to SSL registry without certs
      --media-type strings            accepted media types
  -o, --output string                 output file path
  -p, --password string               registry password or identity token
      --password-stdin                read password or identity token from stdin
      --plain-http                    allow insecure connections to registry without SSL check
      --platform string               fetch the manifest of a specific platform if target is multi-platform capable
      --pretty                        prettify JSON objects printed to stdout
      --registry-config stringArray   auth config path
  -u, --username string               registry username
  -v, --verbose                       verbose output

Provides more examples or add the form messages for platform flag, e.g.,

--platform string               fetch the manifest of a specific platform if target is multi-platform capable, specifies the platform in the form os/arch[/variant][:osversion] (e.g. linux/amd64)
@qweeah
Copy link
Contributor

qweeah commented Sep 22, 2022

Since arch may come from $env:GOOS, I will make it optional

@qweeah qweeah added the ux User experience related label Sep 22, 2022
@shizhMSFT shizhMSFT moved this to Done in ORAS-Planning Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ux User experience related
Projects
No open projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants