Command Line Interface (CLI) | Zoho Vault

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. Download the Zoho Vault CLI here.

Setting up your CLI 
  1. Add the package path to the environment variable to ensure it can work from any path. 
  2. Once set, you can log in into your Zoho account using the command zv login
  3. Access the URL displayed in the console from your browser to validate your authentication. 
  4. 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 options

Command
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 CRM Training
      Redefine the way you work
      with Zoho Workplace

        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 CRM Training

          Create, share, and deliver

          beautiful slides from anywhere.

          Get Started Now


            Zoho Sign now offers specialized one-on-one training for both administrators and developers.

            BOOK A SESSION








                                    You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                        Manage your brands on social media

                                          Zoho Desk Resources

                                          • Desk Community Learning Series


                                          • Digest


                                          • Functions


                                          • Meetups


                                          • Kbase


                                          • Resources


                                          • Glossary


                                          • Desk Marketplace


                                          • MVP Corner


                                          • Word of the Day


                                            Zoho Marketing Automation

                                              Zoho Sheet Resources

                                               

                                                  Zoho Forms Resources


                                                    Secure your business
                                                    communication with Zoho Mail


                                                    Mail on the move with
                                                    Zoho Mail mobile application

                                                      Stay on top of your schedule
                                                      at all times


                                                      Carry your calendar with you
                                                      Anytime, anywhere




                                                            Zoho Sign Resources

                                                              Sign, Paperless!

                                                              Sign and send business documents on the go!

                                                              Get Started Now




                                                                      Zoho TeamInbox Resources



                                                                              Zoho DataPrep Resources



                                                                                Zoho DataPrep Demo

                                                                                Get a personalized demo or POC

                                                                                REGISTER NOW


                                                                                  Design. Discuss. Deliver.

                                                                                  Create visually engaging stories with Zoho Show.

                                                                                  Get Started Now









                                                                                                      • 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, ...
                                                                                                      • How do I add an existing password to a folder?

                                                                                                        To add existing passwords to a folder: Select the passwords, then click More (three dots) corresponding to the password. Select Manage Associated Folders (available only in web interface), then select the folder of your choice. Click Save. Make these ...
                                                                                                      • How do I move a password from one folder to another?

                                                                                                        To move your passwords to a different folder: Select the passwords, then click More (three dots) corresponding to the password. Select Manage Associated Folders (available only in web interface), then select the list of folders that can access your ...
                                                                                                      • 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 ...
                                                                                                        Wherever you are is as good as
                                                                                                        your workplace

                                                                                                          Resources

                                                                                                          Videos

                                                                                                          Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                          eBooks

                                                                                                          Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                          Webinars

                                                                                                          Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                          CRM Tips

                                                                                                          Make the most of Zoho CRM with these useful tips.



                                                                                                            Zoho Show Resources