Skip to content

Commit

Permalink
Add command line section to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
revelaction committed Oct 17, 2023
1 parent c205d75 commit 4ee2b50
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -368,3 +368,36 @@ if hash privage; then
PROG=privage source <(privage bash)
fi
```

# Command line options

```console
⤷ privage help
NAME:
privage - password manager/encryption tool based on age

USAGE:
privage [global options] command [command options] [arguments...]

COMMANDS:
init Add a .gitignore, age/yubikey key file to the current directory. Add a config file in the home directory.
key Decrypt the age private key with the PIV key defined in the .privage.conf file.
status Provide information about the current configuration.
add Add a new encrypted file.
delete Delete an encrypted file.
list list metadata of all/some encrypted files.
show Show the contents the an encripted file.
clipboard Copy the credential password to the clipboard
decrypt Decrypt a file and write its content in a file named after the label
reencrypt Reencrypt all decrypted files that are already encrypted. (default is dry-run)
rotate Create a new age key and reencrypt every file with the new key
bash Dump bash complete script.
help, h Shows a list of commands or help for one command

GLOBAL OPTIONS:
--conf value, -c value Use file as privage configuration file
--key value, -k value Use file path for private key
--piv-slot value, -p value The PIV slot for decryption of the age key
--repository value, -r value Use file path as path for the repository
--help, -h show help
```

0 comments on commit 4ee2b50

Please sign in to comment.