Command Line Interface
Zoho Vault's command line interface (CLI) acts as a standalone desktop client that allows users to add, edit, search, and modify passwords in their vault. Users can also generate strong new passwords using the built-in password generator. The CLI can be accessed from the terminal of your Linux, Windows, and Mac devices.
Setting up your CLI
- Add the package path to the environment variable to ensure it can work from any path.
- Once set, you can log in into your Zoho account using the command zv login.
- Access the URL displayed in the console from your browser to validate your authentication.
- Access your Zoho Vault using zv unlock [master-password].
Note: Learn how to set your Vault CLI to path here. Users on newer MacOS versions might see an error stating "zv" was blocked from use because it is not from an identified developer. To fix this, go to Settings > Security & Privacy > General. Select Open Anyway as shown in the screenshot, then try to run the package again. You will get the same error message again but it will include an Open option. Click Open to run the package normally. Available commands
The following commands are currently supported in the Vault CLI. You can list all the available commands using zv or zv -h commands. To learn more about any particular command and its usage, use zv <command> -h or zv <command> --help. Use the following commands with ./ in front of them on Linux and Mac OS.
Command | Description |
add | Add passwords to Zoho Vault |
download | Download file attachments from your vault |
generate-password | Generate new passwords |
generate-template | Generate password templates |
get | Find complete details about your password |
get-default | Display default values of commands |
list | List passwords and password categories |
lock | End your current Zoho Vault session by clearing your master password |
login | Log in to your Zoho account |
logout | Log out of your Zoho account |
search | Search for passwords in your vault |
set-default | Set default values for commands |
unlock | Access your Zoho Vault account |
update | Edit and update password details |
Commands with detailed actions
Let's take a deeper look into possible commands you can run based on the operation.
View Passwords
Command | Description |
zv add | Add new passwords |
zv generate-template | Generate template to add passwords using a template |
zv add -f <file> | Add passwords using the template file |
Search Passwords
Command | Description |
zv search -k <search-term> | Search all your passwords |
zv search -k <search-term> --name | Search matching terms by name |
zv search -k <search-term> --tags | Search matching terms that have tags |
zv search -k <search-term> --desc | Search matching terms by description |
Update Passwords
Command | Description |
zv update -id <password-id> | Update passwords using the password ID |
zv search -k <password-name> | Find the password ID |
Generate Strong Passwords
Command | Description |
zv generate-password | Generate passwords |
zv generate-password --use-password-policy | Generate passwords using the password policies |
zv generate-password -len 10 -upper -lower -number -spl 3 | Generate passwords using custom options in generator |
Defaults in Zoho Vault CLI
Configure defaults for repetitive options specific to a command.
Note: Use --use-default in commands to execute them with default optionsCommand | Description |
zv set-default | Add a new default |
zv set-default --command <commands> | Add a new default for a specific command |
zv get-default | View all default values |
Terminating your session
Command | Description |
zv logout | Log out from your session |
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
Still can't find what you're looking for?
Write to us: support@zohoforms.com
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Bigin?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
Related Articles
How to add Zoho Vault's CLI to Path?
Adding Zoho Vault's CLI to Path Based on your OS, follow the steps mentioned below to add Vault's CLI to Path. For Windows Copy the file path of your Zoho Vault CLI Access the system's Control Panel, then click Advanced System Settings Click ...Import Users from Active Directory
Zoho Vault provides a user provisioning app that can import users and periodically be in sync with your AD/LDAP user list, simplifying user management. In Windows, you can configure the provisioning app as a scheduled task to automatically add, ...Installing and Configuring ADFS 2.0
This document contains the steps for installing and configuring ADFS 2.0 to work with Zoho Vault. Installing ADFS 2.0: Download and execute ADFSSetup.exe. Click Next. Accept the License Agreement, then click Next. Select Federation Server, then ...Why does my correct master password not get accepted?
Try the following steps to ensure you're typing in the right master password: Verify your email address. If you manage multiple Zoho accounts, ensure you're logging in to the right account. Your master password is case-sensitive. Ensure Caps Lock is ...What are the different password sharing privileges and how do they work?
You can share your passwords with others using four different privileges, namely: One-Click Login Only - Prevents users from viewing the passwords in plain-text. Users with this access can only auto log in to the websites. View - Allows users to view ...