keevo-cli

Keevo CLI toolkits.

Get Started

There're two way to get started

1. Install keevo-cli using npm:

npm install -g @keevo/keevo-cli

To update to latest keevo-cli, just run npm install -g @keevo/keevo-cli again.

2. Use this repo and link to npm

git clone [email protected]:keevo/keevo-cli.git
cd keevo-cli
npm install
npm link

To update to latest keevo-cli, just run git pull && npm install

Helpful commands

1. To check usage document

keevo help

2. To verify current cli version

keevo --version

3. Generate completion script

keevo completion

Modules

Device

Device toolkit. There're bunch of commands you could use to test the communication between node.js and device.

keevo device <command>

Send command to keevo device

Commands:
  keevo device get_info                 Get device info
  keevo device get_state                Get device screen state
  keevo device get_xpub [path]          Get xpub given BIP32 derivation path
  keevo device post_backup_plan [plan]  Post Backup Plan to device
  keevo device sign_tx <transaction>    Send transaction to device for signing

Options:
  --help         Show help                                             [boolean]
  --verbose, -v                                                  [default: true]

To know details about each specific command, you could try --help in deeper level, e.g.

keevo device get_xpub --help
keevo device sign_tx --help

Logging

By default, verbose mode is turned on, so this will try to log all the details for debugging purpose.

To show u2f-host-node's low level log info, you can add an environmental command: DEBUG_DEVICE_DATA=1. e.g.

DEBUG_DEVICE_DATA=1 keevo device get_xpub "m/44'/1'/0'/0/0"

If you really want to turn off verbose mode, you could use

keevo device get_xpub --verbose=0