Zoho Vault CLI

A command-line interface to access and manage your Zoho Vault passwords securely.

Installation

Using npm (recommended)

npm install -g @zohocorporation/vault-cli

Note: Requires Node.js 18 - 20.

Getting Started

1. Log in to your Zoho Vault account

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

zv unlock

You will be prompted for your master password. You can also pass it directly:

zv unlock <masterpassword>

3. Start using commands

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.

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.

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.

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.

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.

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.

zv generate-template -c <category-id>
zv generate-template -c <category-id> -o yaml -w ./template.yaml

download

Download file attachments from vault.

zv download -id <password-id> -d ./downloads

set-default / get-default

Save and retrieve default options for commands.

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 |