From d68ab92a6af47e3ab9aee46a12c17d718d31c443 Mon Sep 17 00:00:00 2001 From: Awiteb Date: Thu, 16 May 2024 23:47:48 +0300 Subject: [PATCH] chore: Add `change-master-password` command doc --- docs/commands/change-master-password.md | 29 +++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/docs/commands/change-master-password.md b/docs/commands/change-master-password.md index 1575e9f..0eee9c1 100644 --- a/docs/commands/change-master-password.md +++ b/docs/commands/change-master-password.md @@ -1,3 +1,32 @@ # Changing the master password ## Usage + +``` +Usage: lprs change-master-password [NEW_PASSWORD] + +Arguments: + [NEW_PASSWORD] The new master password, if there is no value for it you will prompt it + +Options: + -h, --help Print help +``` + +A command to change the master password of the vaults file, you can provide the +new password as an argument or you will be prompted for it. + +### Example +Prompt for the new master password +```bash +lprs change-master-password +``` + +Change the master password to `new-password` +```bash +lprs change-master-password 'new-password' +``` + +## Note +- The master password is used to encrypt and decrypt the vaults file, so if you + forget it you will lose all your vaults. +- This action is irreversible, so make sure to remember the new password. \ No newline at end of file