uxwallet-cli v0.0.3

uxwallet-cli

CLI wallet for Utility X

• Usage
• Commands

Usage

$ npm install -g uxwallet-cli
$ uxwallet COMMAND
running command...
$ uxwallet (-v|--version|version)
uxwallet-cli/0.0.1 darwin-x64 node-v12.16.2
$ uxwallet --help [COMMAND]
USAGE
  $ uxwallet COMMAND
...

Commands

• uxwallet create
• uxwallet hello
• uxwallet help [COMMAND]
• uxwallet list
• uxwallet lock
• uxwallet settings
• uxwallet status
• uxwallet unlock

uxwallet create

Create new wallet store file

USAGE
  $ uxwallet create

OPTIONS
  -l, --location=location  location of the wallet file
  -n, --filename=filename  [default: wallet.json] filename for the wallet file

DESCRIPTION
  The create command is used to create a new wallet store file.
  You can choose to set a custom location and/or filename for the file.

See code: src/commands/create.js

uxwallet hello

Simple command to test sending messages to IPC Server

USAGE
  $ uxwallet hello

OPTIONS
  -n, --name=name  [default: uxwallet1] socket name to send message to

DESCRIPTION
  ...
  Simple command to send a test message to named pipe/socket and view results

See code: src/commands/hello.js

uxwallet help [COMMAND]

display help for uxwallet

USAGE
  $ uxwallet help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

uxwallet list

List the UX wallet files in a directory

USAGE
  $ uxwallet list

OPTIONS
  -l, --location=location  location of the wallet file

DESCRIPTION
  The list command will list all of the available UX wallet files in a
  specific directory that. Since wallet files are encrypted, this command
  will look for files that end with .json and only contain chars [a-f0-9].

See code: src/commands/list.js

uxwallet lock

Lock wallet store file

USAGE
  $ uxwallet lock

OPTIONS
  -l, --location=location  location of the wallet file
  -n, --filename=filename  [default: wallet.json] filename for the wallet file

DESCRIPTION
  The unlock command is used to unlock a wallet file.
  You can specify a custom location and/or filename for the file.

See code: src/commands/lock.js

uxwallet settings

Set local config settings for the CLI wallet

USAGE
  $ uxwallet settings

OPTIONS
  -l, --location=location  location of the settings file
  -n, --filename=filename  [default: ux-cli-settings.json] filename for the settings file

DESCRIPTION
  The settings command is used to configure the local CLI wallet. Configuring the
  wallet can help save time by auto-filling various command options.

See code: src/commands/settings.js

uxwallet status

Check status of named IPC socket

USAGE
  $ uxwallet status

OPTIONS
  -n, --name=name  [default: uxwallet1] socket name to check

DESCRIPTION
  This command will attempt to connect to the
  socket specified with -n and return its status

See code: src/commands/status.js

uxwallet unlock

Unlock wallet store file

USAGE
  $ uxwallet unlock

OPTIONS
  -l, --location=location  location of the wallet file
  -n, --filename=filename  [default: wallet.json] filename for the wallet file

DESCRIPTION
  The unlock command is used to unlock a wallet file.
  You can specify a custom location and/or filename for the file.

See code: src/commands/unlock.js