Skip to content

Commit 2391c96

Browse files
committed
README.md
1 parent 303cd59 commit 2391c96

File tree

2 files changed

+19
-19
lines changed

2 files changed

+19
-19
lines changed

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,20 +35,20 @@ AUTHOR(S):
3535
Jeff Malnick <malnick@gmail.com>
3636
3737
COMMANDS:
38-
rename Rename an entry in the vault
39-
rotate Rotate your cryptorious SSH keys and vault automatically
40-
delete Remove an entry from the cryptorious vault
41-
decrypt Decrypt a value in the vault `VALUE`
42-
encrypt Encrypt a value for the vault `VALUE`
43-
generate Generate a unique RSA public and private key pair for a user specified by user_name or with -user
38+
rename Rename an entry in the vault
39+
rotate Rotate your cryptorious SSH keys and vault automatically
40+
delete Remove an entry from the cryptorious vault
41+
decrypt Decrypt a value in the vault `VALUE`
42+
encrypt Encrypt a value for the vault `VALUE`
43+
generate Generate a RSA keys or a secure password.
4444
4545
GLOBAL OPTIONS:
46-
--vault-path, --vp "/home/malnick/.cryptorious/vault.yaml" Path to vault.yaml.
47-
--private-key, --priv "/home/malnick/.ssh/cryptorious_privatekey" Path to private key.
48-
--public-key, --pub "/home/malnick/.ssh/cryptorious_publickey" Path to public key.
49-
--debug Debug/Verbose log output.
50-
--help, -h show help
51-
--version, -v print the version
46+
--vault-path, --vp "/home/malnick/.cryptorious/vault.yaml" Path to vault.yaml
47+
--private-key, --priv "/home/malnick/.ssh/cryptorious_privatekey" Path to private key
48+
--public-key, --pub "/home/malnick/.ssh/cryptorious_publickey" Path to public key
49+
--debug Debug/Verbose log output
50+
--help, -h Show help
51+
--version, -v Print the version
5252
5353
```
5454
### Decrypt Sub Menu
@@ -61,8 +61,8 @@ USAGE:
6161
6262
OPTIONS:
6363
--copy, -c Copy decrypted password to clipboard automatically
64-
--goto, -g Open your default browser to https://<key_name> and login automatically.
65-
--timeout, -t "10" Timeout in seconds for the decrypt session window to expire.
64+
--goto, -g Open your default browser to https://<key_name> and login automatically
65+
--timeout, -t "10" Timeout in seconds for the decrypt session window to expire
6666
```
6767
### Rename Sub Menu
6868
```
@@ -79,14 +79,14 @@ OPTIONS:
7979
### Generate Sub Menu
8080
```
8181
NAME:
82-
generate - Generate a unique RSA public and private key pair for a user specified by user_name or with -user
82+
generate - Generate a RSA keys or a secure password
8383
8484
USAGE:
8585
generate command [command options] [arguments...]
8686
8787
COMMANDS:
88-
keys Generate SSH key pair for cryptorious
89-
password Generate a random password
88+
keys Generate SSH key pair for cryptorious
89+
password [--[l]ength] Generate a random password
9090
9191
OPTIONS:
9292
--help, -h show help
@@ -154,7 +154,7 @@ cryptorious rotate
154154
1. Backs up your old keys to `keyPath.bak`
155155
1. Backs up your old vault to `vaultPath.bak`
156156
1. Generates new keys to `keyPath`
157-
1. Decrypts vault using `privateKey.bak` and encrypts vault in place with new `privateKey`
157+
1. Decrypts vault using `cryptorious_privatekey.bak` and encrypts vault in place with new `cryptorious_publickey`
158158
1. Writes the vault back to disk at `vaultPath`
159159

160160
## Step 5: Generate Secure Password

cli/cli.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ func Start() error {
151151
{
152152
Name: "generate",
153153
Aliases: []string{"g"},
154-
Usage: "Generate a unique RSA public and private key pair for a user specified by user_name or with -user",
154+
Usage: "Generate a RSA keys or a secure password.",
155155
Subcommands: []cli.Command{
156156
{
157157
Name: "keys",

0 commit comments

Comments
 (0)