Skip to content

CLI.md

Latest commit

 

History

History
56 lines (36 loc) · 1.39 KB

CLI.md

File metadata and controls

56 lines (36 loc) · 1.39 KB

Command Line Interface

There is a collection of command line tools that can be accessed as follows:

yarn run cli --help

Output:

cli

  Verida Command Line Interface 

Synopsis

  cli 

Commands

  Connect         Connect to a third party data provider and save the credentials into the Verida:  
                  Vault context                                                                     
  Sync            Sync to a third party data provider and save the credentials into the Verida:     
                  Vault context                                                                     
  Data            Show data for a given schema                                                      
  ResetProvider   Clear all the data and reset sync positions for a provider                        
  help            Show help.

You can get help on each command as follows:

yarn run cli Connect --help

Output:

cli

  Connect to a third party data provider and save the credentials into the      
  Verida: Vault context                                                         

Synopsis

  cli Connect --provider string [--key string --network string] 

Options

  -p, --provider string   Unique ID of the provider                   
  -k, --key string        Verida network private key (or seed phrase) 
  -n, --network string    Verida network (banksia, myrtle)