Skip to content

doc: add missing username/password options to commands #293

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.

Sign up for GitHub

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

Merged
shizhMSFT merged 3 commits into from
Aug 17, 2022
Merged

doc: add missing username/password options to commands #293

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6c55202
doc: add missing username/password options to commands
binbin-li Aug 10, 2022
721cd95
doc: add description
binbin-li Aug 17, 2022
262cc16
refactor: fix indentation
binbin-li Aug 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 35 additions & 2 deletions specs/notation-cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,12 @@ COMMANDS:
help, h Shows a list of commands or help for one command

OPTIONS:
--help, -h show help (default: false)
--username value, -u value Username for registry operations [$NOTATION_USERNAME]
--password value, -p value Password for registry operations [$NOTATION_PASSWORD]
--help, -h show help (default: false)

GLOBAL ARGUMENTS
--plain-http Registry access via plain HTTP (default: false)
```

## certificate
Expand Down Expand Up @@ -123,7 +128,12 @@ USAGE:
notation list [command options] <reference>

OPTIONS:
--help, -h show help (default: false)
--username value, -u value Username for registry operations [$NOTATION_USERNAME]
--password value, -p value Password for registry operations [$NOTATION_PASSWORD]
--help, -h show help (default: false)

GLOBAL ARGUMENTS
--plain-http Registry access via plain HTTP (default: false)
```

## login
Expand Down Expand Up @@ -154,6 +164,9 @@ notation login -u <user> -p <password> registry.example.com

# Login using $NOTATION_USERNAME $NOTATION_PASSWORD variables
notation login registry.example.com

NOTES
Once login is completed, then -u -p is no longer required for any notation commands against the registry server authenticated.
```

## plugin
Expand Down Expand Up @@ -185,9 +198,14 @@ USAGE:
notation pull [command options] <reference>

OPTIONS:
--username value, -u value Username for registry operations [$NOTATION_USERNAME]
--password value, -p value Password for registry operations [$NOTATION_PASSWORD]
--strict Pull the signature without lookup the manifest (default: false)
--output value, -o value Write signature to a specific path
--help, -h Show help (default: false)

GLOBAL ARGUMENTS
--plain-http Registry access via plain HTTP (default: false)
```

## push
Expand All @@ -201,8 +219,13 @@ USAGE:
notation push [command options] <reference>

OPTIONS:
--username value, -u value Username for registry operations [$NOTATION_USERNAME]
--password value, -p value Password for registry operations [$NOTATION_PASSWORD]
--signature value, -s value, -f value signature files (accepts multiple inputs)
--help, -h show help (default: false)

GLOBAL ARGUMENTS
--plain-http Registry access via plain HTTP (default: false)
```

## sign
Expand All @@ -227,7 +250,12 @@ OPTIONS:
--push push after successful signing (default: true)
--push-reference value different remote to store signature
--media-type value specify the media type of the manifest read from file or stdin (default: "application/vnd.docker.distribution.manifest.v2+json")
--username value, -u value Username for registry operations [$NOTATION_USERNAME]
--password value, -p value Password for registry operations [$NOTATION_PASSWORD]
--help, -h show help (default: false)

GLOBAL ARGUMENTS
--plain-http Registry access via plain HTTP (default: false)
```

## verify
Expand All @@ -247,5 +275,10 @@ OPTIONS:
--pull pull remote signatures before verification (default: true)
--local, -l reference is a local file (default: false)
--media-type value specify the media type of the manifest read from file or stdin (default: "application/vnd.docker.distribution.manifest.v2+json")
--username value, -u value Username for registry operations [$NOTATION_USERNAME]
--password value, -p value Password for registry operations [$NOTATION_PASSWORD]
--help, -h show help (default: false)

GLOBAL ARGUMENTS
--plain-http Registry access via plain HTTP (default: false)
```