Overview

CovenantSQL provides a cql command line toolset for terminal users to access and manage user accounts, wallet balances, and databases. Check the complete toolset installation tutorial at CovenantSQL Toolset installation.

Private Key and Config File

The cql command needs to rely on a private key file private.key and a config file config.yaml:

• private.key：a private key file which is generated while creating an account, be sure to keep it safe
• config.yaml：mainly used to config the CovenantSQL network for cql command to connect (e.g., the TestNet or the Docker Environment)

For security, the private key file is usually encrypted with a master key. A master key is individually chosen by the user while creating an account and is memorized or kept somewhere by the user -- note that the config file will not keep the master key. When the private key is required by the cql command, it will ask the user to input the master key to decrypt the private key file.

Common Parameters for Sub-commands

The following parameters are commonly used by cql sub-commands:

-bypass-signature
      Disable signature signing and verifying, for testing only
-config string
      Config file for covenantsql (Usually no need to set, default is enough.) (default "~/.cql/config.yaml")
-no-password
      Use an empty master key
-password string
      Master key for covenantsql (NOT SAFE, for debugging or script mode only)

Note that the private key file path is specified in the config file, and its default value is ./private.key, indicating that it's located in the same directory of the config. So usually we put the private key file together with config, instead of using an individual parameter to specify the private key file.