@zohocorporation/vault-cli 1.1.2 → 1.1.3

package/README.md

@@ -1,16 +1,148 @@
-# ZohoVault CLI
-
-Steps to get CLI locally
-
-- Run `npm install --registry http://cm-npmregistry` to get dependency packages in package.json. The npm packages present in cm-npmregistry are approved, and others should be approved by legal team.
-- Run `npm run setup` to set up the developer environment.
-- Run `npm run dev` to compile the code and watch for current changes 
-- Run `npm run build` to build zv.cjs file
-- For generating binaries based on the os, run one of the following commands:
-    - Windows: `npm run pkg:win`
-    - Linux: `npm run pkg:lin`
-    - MacOS: `npm run pkg:mac`
-    - Linux-arm: `npm run pkg:lin-arm`
-    - Mac-arm: `npm run pkg:mac-arm`
-    The binary will be present in `bundle/<os>/`
-- For generating all five binaries run `npm run pkg`. 
+# Zoho Vault CLI
+
+A command-line interface to access and manage your Zoho Vault passwords securely.
+
+## Installation
+
+### Using npm (recommended)
+```bash
+npm install -g @zohocorporation/vault-cli
+```
+
+
+> **Note:** Requires Node.js 18 - 20.
+
+## Getting Started
+
+### 1. Log in to your Zoho Vault account
+```bash
+zv login --dc us
+```
+The `--dc` flag specifies your data center: `us` (default), `eu`, `in`, `au`, or `com.cn`. You can identify your DC from your Zoho domain (e.g., `zoho.in` → `in`, `zoho.eu` → `eu`).
+
+### 2. Unlock your vault
+```bash
+zv unlock
+```
+You will be prompted for your master password. You can also pass it directly:
+```bash
+zv unlock <masterpassword>
+```
+
+### 3. Start using commands
+```bash
+zv search -k "gmail"
+zv list password
+zv get -id <password-id>
+```
+
+## Commands
+
+### Account
+
+| Command | Description |
+|---------|-------------|
+| `zv login --dc <loc>` | Log in to your Zoho Vault account |
+| `zv unlock [masterpassword]` | Access your Zoho Vault account |
+| `zv lock` | Lock your Zoho Vault account |
+| `zv logout` | Log out from the Zoho Vault CLI |
+| `zv reset` | Log out all Zoho Vault accounts |
+
+### Passwords
+
+| Command | Description |
+|---------|-------------|
+| `zv search -k <term>` | Search for passwords in your vault |
+| `zv list <category>` | List passwords or password categories |
+| `zv get -id <password-id>` | Get complete details about a password |
+| `zv add -id <category-id>` | Add a password to Zoho Vault |
+| `zv update -id <password-id>` | Edit password details |
+| `zv download -id <password-id> -d <path>` | Download file attachments from vault |
+
+### Utilities
+
+| Command | Description |
+|---------|-------------|
+| `zv generate-password` | Generate a password |
+| `zv generate-template -c <category-id>` | Generate a template for adding passwords |
+| `zv set-default -c <command>` | Set default values for commands |
+| `zv get-default` | Display default values of commands |
+
+## Command Details
+
+### search
+Search for passwords in your vault.
+```bash
+zv search -k "gmail"                  # Basic search
+zv search -k "gmail" -s               # Strict (exact match)
+zv search -k "gmail" -n               # Include password name in search
+zv search -k "gmail" -V               # Verbose output (all fields)
+zv search -k "gmail" -show            # Display passwords in plain text
+zv search -k "gmail" -o json          # Output as json, yaml, table, or xml
+zv search -k "gmail" -w ./output.json # Save output to file
+zv search --use-default               # Use saved default options
+```
+
+### list
+List passwords or categories.
+```bash
+zv list password                       # List all passwords
+zv list category                       # List all categories
+zv list password -c <category-id>      # List passwords in a category
+zv list password -V                    # Verbose output
+zv list password -show                 # Display passwords in plain text
+```
+
+### get
+Get complete details about a password.
+```bash
+zv get -id <password-id>               # Get password details
+zv get -id <password-id> --not-safe    # Show password in plain text
+zv get -id <password-id> -o json       # Output as json, yaml, table, or xml
+zv get -id <password-id> -w ./out.json # Save output to file
+```
+
+### add
+Add passwords to Zoho Vault.
+```bash
+zv add -id <category-id>              # Add a password interactively
+zv add -f ./template.json             # Import passwords from a template file
+```
+
+### generate-password
+Generate a password with custom rules.
+```bash
+zv generate-password -len 16 -upper -lower -number -spl 2
+zv generate-password -g -p <policy-id>   # Use a password policy
+zv generate-password -exclude "0Ol1"     # Exclude ambiguous characters
+```
+
+### generate-template
+Generate a template for adding passwords.
+```bash
+zv generate-template -c <category-id>
+zv generate-template -c <category-id> -o yaml -w ./template.yaml
+```
+
+### download
+Download file attachments from vault.
+```bash
+zv download -id <password-id> -d ./downloads
+```
+
+### set-default / get-default
+Save and retrieve default options for commands.
+```bash
+zv set-default -c search              # Set defaults for search
+zv set-default -c "search,list,get"   # Set defaults for multiple commands
+zv set-default -clr                   # Clear all defaults
+zv get-default                        # Show all defaults
+zv get-default -c search              # Show defaults for a specific command
+```
+
+## Global Options
+
+| Flag | Description |
+|------|-------------|
+| `-v, --version` | Display the CLI version |
+| `-h, --help` | Display help for a command |

package/out/zv.js

@@ -35,7 +35,7 @@ getDefaultCmd(program);
 setDefaultCmd(program);
 reset(program);
 program
-    .version('1.1.2', '-v --version', 'Display the CLI version')
+    .version('1.1.3', '-v --version', 'Display the CLI version')
     .description('Zoho Vault Command Line Interface');
 program.parse(process.argv);
 //# sourceMappingURL=zv.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zohocorporation/vault-cli",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Zoho Vault Command Line Interface",
   "main": "index.js",
   "type": "module",
@@ -44,7 +44,7 @@
     "@napi-rs/keyring": "1.1.6",
     "atob": "2.1.2",
     "axios": "1.7.7",
-    "better-sqlite3": "9.4.3",
+    "better-sqlite3": "12.6.2",
     "chalk": "5.3.0",
     "cli-highlight": "2.1.11",
     "cli-progress": "3.11.2",
@@ -90,7 +90,7 @@
     ]
   },
   "engines": {
-    "node": ">=18",
+    "node": ">=18 <=20",
     "npm": ">=5.0.0"
   }
 }