man/awskeyring.5.ronn in awskeyring-1.6.0 vs man/awskeyring.5.ronn in awskeyring-1.7.0
- old
+ new
@@ -14,56 +14,84 @@
The commands are as follows:
* --version, -v:
- Prints the version
+ Prints the version<br>
+ -r, --no-remote: Do not validate with remote api.
+
* add ACCOUNT:
- Adds an ACCOUNT to the keyring
+ Adds an ACCOUNT to the keyring<br>
+ -k, --key=KEY: AWS account key id.<br>
+ -s, --secret=SECRET: AWS account secret.<br>
+ -m, --mfa=MFA: AWS virtual mfa arn.<br>
+ -r, --no-remote: Do not validate with remote api.
+
* add-role ROLE:
- Adds a ROLE to the keyring
+ Adds a ROLE to the keyring<br>
+
+ -a, --arn=ARN: AWS role arn.
-* console ACCOUNT:
+* awskeyring console ACCOUNT:
- Open the AWS Console for the ACCOUNT
+ Open the AWS Console for the ACCOUNT<br>
+ -p, --path=PATH: The service PATH to open.<br>
+ -b, --browser=BROWSER: Specify an alternative browser.<br>
+ -n, --no-token: Do not use saved token.<br>
+ -o, --no-open: Do not open the url.
+
* env ACCOUNT:
- Outputs bourne shell environment exports for an ACCOUNT
+ Outputs bourne shell environment exports for an ACCOUNT<br>
+ -n, --no-token: Do not use saved token.<br>
+ -u, --unset, --no-unset: Unset environment variables.
+
* exec ACCOUNT command...:
- Execute a COMMAND with the environment set for an ACCOUNT
+ Execute a COMMAND with the environment set for an ACCOUNT<br>
+ -n, --no-token: Do not use saved token.<br>
+ -b, --no-bundle: Unset Bundler environment variables.
+
* help [COMMAND]:
Describe available commands or one specific command
* import:
- Import an ACCOUNT to the keyring from ~/.aws/credentials
+ Import an ACCOUNT to the keyring from ~/.aws/credentials<br>
+ -r, --no-remote: Do not validate with remote api.
+
* initialise:
- Initialises a new KEYCHAIN
+ Initialises a new KEYCHAIN<br>
+ -n, --keychain=KEYCHAIN: Name of KEYCHAIN to initialise.
+
* json ACCOUNT:
- Outputs AWS CLI compatible JSON for an ACCOUNT
+ Outputs AWS CLI compatible JSON for an ACCOUNT<br>
+ -n, --no-token: Do not use saved token.
+
* list:
Prints a list of accounts in the keyring
* list-role:
- Prints a list of roles in the keyring
+ Prints a list of roles in the keyring<br>
+ -d, --detail, --no-detail: Show more detail.
+
* remove ACCOUNT:
Removes an ACCOUNT from the keyring
* remove-role ROLE:
@@ -78,16 +106,24 @@
Rotate access keys for an ACCOUNT
* token ACCOUNT [ROLE] [MFA]:
- Create an STS Token from a ROLE or an MFA code
+ Create an STS Token from a ROLE or an MFA code<br>
+ -r, --role=ROLE: The ROLE to assume.<br>
+ -c, --code=CODE: Virtual mfa CODE.<br>
+ -d, --duration=DURATION: Session DURATION in seconds.
+
* update ACCOUNT:
- Updates an ACCOUNT in the keyring
+ Updates an ACCOUNT in the keyring<br>
+ -k, --key=KEY: AWS account key id.<br>
+ -s, --secret=SECRET: AWS account secret.<br>
+ -r, --no-remote: Do not validate with remote api.
+
## ENVIRONMENT
The AWS_DEFAULT_REGION environment variable will be used for AWS API calls where specified or fall back to us-east-1
when not.
@@ -130,9 +166,10 @@
## CONTRIBUTORS
* Tristan [tristanmorgan](https://github.com/tristanmorgan)
* Adam Sir [AzySir](https://github.com/AzySir)
+* Vito Giarrusso [thtliife](https://github.com/thtliife)
## LICENSE
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).