awskeyring.5 in awskeyring-1.10.0

- old
+ new

@@ -1,9 +1,9 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "AWSKEYRING" "5" "October 2022" "" ""
+.TH "AWSKEYRING" "5" "November 2022" "" ""
 .
 .SH "NAME"
 \fBAwskeyring\fR \- is a small tool to manage AWS account keys in the macOS Keychain
 .
 .SH "SYNOPSIS"
@@ -39,18 +39,18 @@
 .
 .IP
 \-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\.
 .
+.br
+\-s, \-\-secret=SECRET: AWS account secret\.
+.
 .TP
 add\-role ROLE:
 .
 .IP
 Adds a ROLE to the keyring
@@ -67,30 +67,33 @@
 Open the AWS Console for the ACCOUNT
 .
 .br
 .
 .IP
-\-p, \-\-path=PATH: The service PATH to open\.
+\-b, \-\-browser=BROWSER: Specify an alternative browser\.
 .
 .br
-\-b, \-\-browser=BROWSER: Specify an alternative browser\.
+\-o, \-\-no\-open: Do not open the url\.
 .
 .br
 \-n, \-\-no\-token: Do not use saved token\.
 .
 .br
-\-o, \-\-no\-open: Do not open the url\.
+\-p, \-\-path=PATH: The service PATH to open\.
 .
 .TP
 env ACCOUNT:
 .
 .IP
 Outputs bourne shell environment exports for an ACCOUNT
 .
 .br
 .
 .IP
+\-f, \-\-force: Force output to a tty\.
+.
+.br
 \-n, \-\-no\-token: Do not use saved token\.
 .
 .br
 \-u, \-\-unset, \-\-no\-unset: Unset environment variables\.
 .
@@ -101,14 +104,14 @@
 Execute a COMMAND with the environment set for an ACCOUNT
 .
 .br
 .
 .IP
-\-n, \-\-no\-token: Do not use saved token\.
+\-b, \-\-no\-bundle: Unset Bundler environment variables\.
 .
 .br
-\-b, \-\-no\-bundle: Unset Bundler environment variables\.
+\-n, \-\-no\-token: Do not use saved token\.
 .
 .TP
 help [COMMAND]:
 .
 .IP
@@ -143,10 +146,13 @@
 Outputs AWS CLI compatible JSON for an ACCOUNT
 .
 .br
 .
 .IP
+\-f, \-\-force: Force output to a tty\.
+.
+.br
 \-n, \-\-no\-token: Do not use saved token\.
 .
 .TP
 list:
 .
@@ -212,14 +218,14 @@
 .
 .IP
 \-k, \-\-key=KEY: AWS account key id\.
 .
 .br
-\-s, \-\-secret=SECRET: AWS account secret\.
+\-r, \-\-no\-remote: Do not validate with remote api\.
 .
 .br
-\-r, \-\-no\-remote: Do not validate with remote api\.
+\-s, \-\-secret=SECRET: AWS account secret\.
 .
 .SH "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\.
 .
 .SH "EXIT STATUS"
@@ -285,9 +291,50 @@
 .nf
 
 complete \-C /usr/local/bin/awskeyring awskeyring
 .
 .fi
+.
+.IP "" 0
+.
+.SH "CONFIGURATION"
+A Configuration file is stored in the users home directory at \fB~/\.awskeyring\fR as a JSON formatted file\. Most of the fields have a default value except the awskeyring field\.
+.
+.IP "" 4
+.
+.nf
+
+{
+  "awskeyring": "awskeyring",
+  "browser":    ["FireFox", "Google Chrome", "Safari"],
+  "console":    ["ec2/v2", "cloudwatch", "iam"],
+  "keyage":     90
+}
+.
+.fi
+.
+.IP "" 0
+.
+.IP "1." 4
+The first field is the Keychain that your keys will be saved in\.
+.
+.br
+
+.
+.IP "2." 4
+A list of your browsers to use the console command with\.
+.
+.br
+
+.
+.IP "3." 4
+The next is the list of AWS Console pages autocomplete will present\.
+.
+.br
+
+.
+.IP "4." 4
+The last field is the warning threshold for key age\.
 .
 .IP "" 0
 .
 .SH "HISTORY"
 The motivation of this application is to provide a local secure store of AWS credentials using specifically in the macOS Keychain, to have them easily accessed from the Terminal, and to provide useful functions like assuming roles and opening the AWS Console from the cli\. It then expanded to include autocomplete and a desire to have an almost complete test coverage to prevent regressions in its functionality\. For Enterprise environments there are better suited tools to use like HashiCorp Vault \fIhttps://vaultproject\.io/\fR\.