Zeeve CLI Tool

A CLI tool to access Zeeve's services.

Installation

npm i -g zeeve

Commands

Login command

The login command logs in with provided cli configuration which requires cli access key , cli secret key , login endpoint , deployment endpoints for deploying corda or other applications.

It also has an option for agent server address which helps in spawning the agent which connects with the ncs.

This is a one time process for each cli credential i.e. you dont have to login everytime you deploy your application .

If you want to deploy with different endpoint or cli credential , you will have to call login command again with the changed configuration.

Usage : zeeve login [options]

Options:

  -i, --access-id <access-id>              Auth Access ID
  -s, --secret <secret>                    Auth Secret
  -ae, --login-endpoint <endpoint>         Endpoint for cli login
  -ce, --corda-deploy-endpoint <endpoint>  corda deployment endpoint
  -ws, --ws-server-address <address>      web socket server address for agent
  -fe, --fabric-endpoint <endpoint>       fabric backend endpoint
  -h, --help                               display help for command

Example

zeeve login -i a3as3d3d3s4 -s s4s46s46s4sSs4 -ae https://a.example.com/login -ce https://b.example.com/deploy -ws wss://c.example.com -fe https://d.example.com/fabric-backend

Deploy command

Deploy command simply schedules the application (corda ) for deployment . This command just requires a path to application tar file to be uploaded and a network id of the network where the application will be deployed .

The command starts with a protocol name i.e. corda followed by its deploy command .

Usage : zeeve corda corda-deploy [options]

Options:

  -f, --file-path <file-path>    File path for cordapp zip file
  -n, --network-id <network-id>  Id of the Network
  -h, --help                     display help for command

Example

zeeve corda corda-deploy -f /some/path/to/application.tar.gz -n d3d3f5f445f45Y3

Install Command

zeeve install command lets you install plugins for zeeve cli.

Available Plugins:

1. Corda Enterprise plugin.

Usage:

 zeeve install corda-enterprise-plugin [version] 

version: version of the corda enterprise plugin.

Example

zeeve install corda-enterprise-plugin 1.0.0 

Note: argument version is optional. latest version of corda enterprise plugin will be installed if not given.

after installation you can access the corda enterprise commands with zeeve corda enterprise

read more about corda enterprise plugin here