Update docs

ThilinaManamgoda · Apr 19, 2020 · 6846997 · 6846997
1 parent 107d1b6
commit 6846997
Show file tree

Hide file tree

Showing 13 changed files with 55 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -176,6 +176,17 @@ If all the Storage types are enabled, the priority will be given as follow,
 * Google drive storage
 * Local file storage
 
+### Upgrading password database version 
+When upgrading password-manager cli, please make sure that whether it is required to upgrade the password database as well.
+**It will be mentioned in the release note**. If it is mentioned in the release note that the password-database must be upgraded,
+ then after installing run the following command,
+
+`password-manager upgrade-db`
+
+
+This command upgrades the password database to latest version and creates a backup of the current password database. 
+Please find more details on `upgrade-db` command [here](doc/password-manager_upgrade-db.md).
+
 ### SEE ALSO
 
 * [password-manager init](doc/password-manager_init.md)	 - Initialize the Password Manager
@@ -188,6 +199,7 @@ If all the Storage types are enabled, the priority will be given as follow,
 * [password-manager import](doc/password-manager_import.md)	 - Import passwords
 * [password-manager export](doc/password-manager_export.md)	 - Export password repository to a file
 * [password-manager remove](doc/password-manager_remove.md)	 - Remove a password
+* [password-manager upgrade-db](doc/password-manager_upgrade-db.md)	 - Upgrade password database to verion 
 
 
 
diff --git a/cmd/upgrade_db.go b/cmd/upgrade_db.go
@@ -25,8 +25,8 @@ import (
 // getCmd represents the get command
 var upgradeDBCmd = &cobra.Command{
 	Use:   "upgrade-db",
-	Short: fmt.Sprintf("Upgrade password database to verion %s", passwords.DatabaseVersion),
-	Long:  fmt.Sprintf("Upgrade password database to verion %s", passwords.DatabaseVersion),
+	Short: "Upgrade password database to latest version",
+	Long:  "Upgrade password database to latest version and create a backup of the current password database",
 	RunE: func(cmd *cobra.Command, args []string) error {
 		mPassword, err := inputs.GetFlagStringVal(cmd, inputs.FlagMasterPassword)
 		if err != nil {

diff --git a/doc/password-manager_add.md b/doc/password-manager_add.md
@@ -13,6 +13,7 @@ password-manager add [ID] [flags]
 ### Options
 
 ```
+  -d, --description string   Description
   -h, --help                 help for add
   -i, --interactive          Enable interactive mode
   -l, --labels stringArray   Labels for the password entry
@@ -28,6 +29,5 @@ password-manager add [ID] [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_change-master-password.md b/doc/password-manager_change-master-password.md
@@ -25,6 +25,5 @@ password-manager change-master-password [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_change.md b/doc/password-manager_change.md
@@ -27,6 +27,5 @@ password-manager change [ID] [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_export.md b/doc/password-manager_export.md
@@ -25,6 +25,5 @@ password-manager export [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_generate-password.md b/doc/password-manager_generate-password.md
@@ -25,6 +25,5 @@ password-manager generate-password [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_get.md b/doc/password-manager_get.md
@@ -4,7 +4,7 @@ Get a password with the ID
 
 ### Synopsis
 
-Get a password with ID
+Get a password with the ID
 
 ```
 password-manager get [ID] [flags]
@@ -25,6 +25,5 @@ password-manager get [ID] [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_import.md b/doc/password-manager_import.md
@@ -25,6 +25,5 @@ password-manager import  [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_init.md b/doc/password-manager_init.md
@@ -24,6 +24,5 @@ password-manager init [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_remove.md b/doc/password-manager_remove.md
@@ -24,6 +24,5 @@ password-manager remove [ID] [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_search.md b/doc/password-manager_search.md
@@ -26,6 +26,5 @@ password-manager search [ID] [flags]
 
 ### SEE ALSO
 
-* [password-manager](password-manager.md)	 - A local Password Manager
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
 
-###### Auto generated by spf13/cobra on 30-Dec-2019
diff --git a/doc/password-manager_upgrade-db.md b/doc/password-manager_upgrade-db.md
@@ -0,0 +1,29 @@
+## password-manager upgrade-db
+
+Upgrade password database to latest version
+
+### Synopsis
+
+Upgrade password database to latest version and create a backup of the current password database
+
+```
+password-manager upgrade-db [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for upgrade-db
+```
+
+### Options inherited from parent commands
+
+```
+  -m, --masterPassword string   Master password
+```
+
+### SEE ALSO
+
+* [password-manager](password-manager.md)	 - Encrypt your passwords into a file and have access with ease.
+
+###### Auto generated by spf13/cobra on 20-Apr-2020