@titandeveos/uxwallet-cli v0.0.91-beta
uxwallet-cli
CLI wallet for Utility X
Usage
$ npm install -g @titandeveos/uxwallet-cli
$ uxcli COMMAND
running command...
$ uxcli (-v|--version|version)
@titandeveos/uxwallet-cli/0.0.91-beta darwin-arm64 node-v18.0.0
$ uxcli --help [COMMAND]
USAGE
$ uxcli COMMAND
...
Commands
uxcli accounts:add ACCOUNT_NAME
uxcli accounts:list
uxcli accounts:remove ACCOUNT_NAME
uxcli accounts:update ACCOUNT_NAME
uxcli apps:add APP
uxcli apps:list
uxcli apps:remove [APP URL]
uxcli autocomplete [SHELL]
uxcli backups:create
uxcli backups:import FILE
uxcli backups:import_anchor FILE
uxcli backups:import_scatter FILE
uxcli chains:add SERVER
uxcli chains:list
uxcli chains:remove SERVER
uxcli config:get [NAME]
uxcli config:init
uxcli config:set [SETTING]
uxcli config:unset [NAME]
uxcli db:addobject DATA
uxcli db:list
uxcli db:lock
uxcli db:read TABLE
uxcli db:removeobject ID
uxcli db:setobject DATA
uxcli db:unlock
uxcli eosio:buyram PAYER RECEIVER AMOUNT
uxcli eosio:claimrewards OWNER
uxcli eosio:delegatebw FROM RECEIVER STAKE_NET_QUANTITY STAKE_CPU_QUANTITY
uxcli eosio:fetch
uxcli eosio:listbw ACCOUNT
uxcli eosio:listproducers
uxcli eosio:regproducer PRODUCER PRODUCER_KEY [URL] [LOCATION]
uxcli eosio:regproxy PROXY
uxcli eosio:sellram ACCOUNT BYTES
uxcli eosio:transfer FROM TO QUANTITY [MEMO]
uxcli eosio:undelegatebw FROM RECEIVER UNSTAKE_NET_QUANTITY UNSTAKE_CPU_QUANTITY
uxcli eosio:unregproducer PRODUCER
uxcli eosio:unregproxy PROXY
uxcli eosio:voteproducer SUBCOMMAND VOTER PRODUCER
uxcli esr:decode TX
uxcli esr:encode TX
uxcli help [COMMAND]
uxcli keys:add KEY
uxcli keys:derive [ROLE] [INDEX]
uxcli keys:list
uxcli keys:remove KEY
uxcli logs
uxcli plugins
uxcli plugins:inspect PLUGIN...
uxcli plugins:install PLUGIN...
uxcli plugins:link PLUGIN
uxcli plugins:uninstall PLUGIN...
uxcli plugins:update
uxcli service:start
uxcli service:stop
uxcli status
uxcli accounts:add ACCOUNT_NAME
Add accounts to the wallet store
USAGE
$ uxcli accounts:add ACCOUNT_NAME
ARGUMENTS
ACCOUNT_NAME account name to add to the wallet store
OPTIONS
-c, --chain_id=chain_id chain_id associated with the account
DESCRIPTION
The accounts:add command is used to add new accounts to the current wallet store.
See code: src/commands/accounts/add.js
uxcli accounts:list
List accounts that are in the wallet store
USAGE
$ uxcli accounts:list
OPTIONS
-a, --account_name=account_name list accounts matching this name
-c, --chain_id=chain_id list accounts associated with this chain_id
DESCRIPTION
The accounts:list command is used to list the existing accounts in the wallet store
See code: src/commands/accounts/list.js
uxcli accounts:remove ACCOUNT_NAME
Remove accounts from the wallet store
USAGE
$ uxcli accounts:remove ACCOUNT_NAME
ARGUMENTS
ACCOUNT_NAME account name to add to the wallet store
OPTIONS
-c, --chain_id=chain_id chain_id associated with the account
DESCRIPTION
The accounts:remove command is used to remove new accounts to the current wallet store.
See code: src/commands/accounts/remove.js
uxcli accounts:update ACCOUNT_NAME
Fetch account data from chain
USAGE
$ uxcli accounts:update ACCOUNT_NAME
ARGUMENTS
ACCOUNT_NAME account name to add to the wallet store
OPTIONS
-c, --chain_id=chain_id chain_id associated with the account
DESCRIPTION
The accounts:update command is used to fetch account data from the chain and
store it in the wallet database.
Notes:
- If --chain_id (-c) is not supplied the user will be prompted to select a known chain.
See code: src/commands/accounts/update.js
uxcli apps:add APP
Add apps to the wallet store
USAGE
$ uxcli apps:add APP
ARGUMENTS
APP json string of the app to add
DESCRIPTION
The apps:add command is used to add new apps to the current wallet store.
See code: src/commands/apps/add.js
uxcli apps:list
List apps that are in the wallet database
USAGE
$ uxcli apps:list
DESCRIPTION
The apps:list command is used to list the existing apps in the wallet database
See code: src/commands/apps/list.js
uxcli apps:remove [APP URL]
Remove apps from the wallet database
USAGE
$ uxcli apps:remove [APP URL]
ARGUMENTS
APP URL url of the app to remove
DESCRIPTION
The apps:remove command is used to remove apps from the walle database
See code: src/commands/apps/remove.js
uxcli autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ uxcli autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ uxcli autocomplete
$ uxcli autocomplete bash
$ uxcli autocomplete zsh
$ uxcli autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
uxcli backups:create
Make a backup of the encrypted wallet store
USAGE
$ uxcli backups:create
OPTIONS
-l, --location=location directory to save the wallet backup archive. default: $HOME/uxwallet/backups
DESCRIPTION
The backups:create command is used to make a new backup of the encryoted wallet store.
Current wallet password will be required to access or import the backup.
See code: src/commands/backups/create.js
uxcli backups:import FILE
Import an existing backup into the wallet store
USAGE
$ uxcli backups:import FILE
ARGUMENTS
FILE location to the wallet archive to import
OPTIONS
-n, --name=name (required) name of the new wallet
DESCRIPTION
The backups:import command is used to import an existing backup of the wallet store.
See code: src/commands/backups/import.js
uxcli backups:import_anchor FILE
Import an existing backup into the wallet store
USAGE
$ uxcli backups:import_anchor FILE
ARGUMENTS
FILE location to the wallet archive to import
OPTIONS
-p, --password=password password to encrypt the backup files with
DESCRIPTION
The backups:import command is used to import an existing backup of the wallet store.
User will be required to enter the password used to create the backup archive in
order to import.
See code: src/commands/backups/import_anchor.js
uxcli backups:import_scatter FILE
Import an existing backup into the wallet store
USAGE
$ uxcli backups:import_scatter FILE
ARGUMENTS
FILE location to the wallet archive to import
OPTIONS
-p, --password=password password for decrypting the backup files with
DESCRIPTION
The backups:import command is used to import an existing backup of the wallet store.
User will be required to enter the password used to create the backup archive in
order to import.
See code: src/commands/backups/import_scatter.js
uxcli chains:add SERVER
Add chains to the wallet store
USAGE
$ uxcli chains:add SERVER
ARGUMENTS
SERVER http(s) address for the api endpoint
DESCRIPTION
The chains:add command is used to add new chains to the current wallet store.
See code: src/commands/chains/add.js
uxcli chains:list
List chains that are in the wallet database
USAGE
$ uxcli chains:list
DESCRIPTION
The chains:list command is used to list the existing chains in the wallet database
See code: src/commands/chains/list.js
uxcli chains:remove SERVER
Remove chains from the wallet database
USAGE
$ uxcli chains:remove SERVER
ARGUMENTS
SERVER http(s) address for the api endpoint
DESCRIPTION
The chains:remove command is used to remove chains from the wallet database
See code: src/commands/chains/remove.js
uxcli config:get [NAME]
Get config settings for the CLI wallet
USAGE
$ uxcli config:get [NAME]
ARGUMENTS
NAME (optional) name of settings to filter by
DESCRIPTION
The settings:get command is used to get existing configuration settings.
See code: src/commands/config/get.js
uxcli config:init
Init configuration file for the CLI
USAGE
$ uxcli config:init
DESCRIPTION
The config:init command is an interactive command used to create the initial
configuration for the CLI wallet.
See code: src/commands/config/init.js
uxcli config:set [SETTING]
Set config settings for the CLI wallet
USAGE
$ uxcli config:set [SETTING]
ARGUMENTS
SETTING JSON string of the setting object to add to the user config. required keys: name, value
DESCRIPTION
The settings:set command is used to set or change configuration settings.
See code: src/commands/config/set.js
uxcli config:unset [NAME]
Unset config settings for the CLI wallet
USAGE
$ uxcli config:unset [NAME]
ARGUMENTS
NAME name of setting to unset in userConfig
DESCRIPTION
The settings:unset command is used to remove existing configuration settings.
See code: src/commands/config/unset.js
uxcli db:addobject DATA
Add new object to the database
USAGE
$ uxcli db:addobject DATA
ARGUMENTS
DATA json string of the object to add
OPTIONS
-t, --table=table (required) name of the table to remove object from
DESCRIPTION
Add new object to the database.
See code: src/commands/db/addobject.js
uxcli db:list
List wallets in the database
USAGE
$ uxcli db:list
See code: src/commands/db/list.js
uxcli db:lock
Lock wallet store file
USAGE
$ uxcli db:lock
DESCRIPTION
The unlock command is used to unlock a wallet file.
See code: src/commands/db/lock.js
uxcli db:read TABLE
Read full tables from the wallet store
USAGE
$ uxcli db:read TABLE
ARGUMENTS
TABLE name of table to read from database
DESCRIPTION
Read full tables from the wallet store.
Use the --showPrivate flag if you wish to see sensitive data in output.
See code: src/commands/db/read.js
uxcli db:removeobject ID
Remove an existing object from the database
USAGE
$ uxcli db:removeobject ID
ARGUMENTS
ID _id of the object to remove
OPTIONS
-t, --table=table (required) name of the table to remove object from
DESCRIPTION
Remove an existing object from the database.
See code: src/commands/db/removeobject.js
uxcli db:setobject DATA
Add or update an object to the wallet database.
USAGE
$ uxcli db:setobject DATA
ARGUMENTS
DATA json string of the object to set
OPTIONS
-t, --table=table (required) name of the table to set object in
DESCRIPTION
Add or update an object to the wallet database.
Notes:
- This command will update an existing object in the database if data contains '_id' field.
See code: src/commands/db/setobject.js
uxcli db:unlock
Unlock wallet store file
USAGE
$ uxcli db:unlock
OPTIONS
-m, --mnemonic=mnemonic mnemonic used to initialize the wallet (if none, random mnemonic will be used)
-p, --password=password password to use to unlock the wallet file (if none, can be entered interactively)
-w, --walletName=walletName name of the wallet database to unlock
DESCRIPTION
The unlock command is used to unlock a wallet file.
Use the --showPrivate flag if you wish to see private keys in output.
See code: src/commands/db/unlock.js
uxcli eosio:buyram PAYER RECEIVER AMOUNT
Buy RAM.
USAGE
$ uxcli eosio:buyram PAYER RECEIVER AMOUNT
ARGUMENTS
PAYER account paying for the RAM
RECEIVER account receiving the bought resources
AMOUNT amount of tokens to pay for RAM
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Buy RAM.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:claimrewards OWNER
Claim producer rewards.
USAGE
$ uxcli eosio:claimrewards OWNER
ARGUMENTS
OWNER account to claim rewards for
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Claim producer rewards.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:delegatebw FROM RECEIVER STAKE_NET_QUANTITY STAKE_CPU_QUANTITY
Delegate bandwidth to a user account
USAGE
$ uxcli eosio:delegatebw FROM RECEIVER STAKE_NET_QUANTITY STAKE_CPU_QUANTITY
ARGUMENTS
FROM account to delegate from
RECEIVER account to delegate to
STAKE_NET_QUANTITY token amount to stake for NET
STAKE_CPU_QUANTITY token amount to stake for CPU
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
-t, --transfer transfer voting and staking rights to account
DESCRIPTION
...
Delegate bandwidth to a user account
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:fetch
Fetch some data from an EOSIO/DFuse endpoint
USAGE
$ uxcli eosio:fetch
OPTIONS
-d, --data=data json formatted string of data to query
-e, --endpoint=endpoint (required) endpoint to query (do not include server; use -s flag to specify server)
-s, --server=server EOSIO node
DESCRIPTION
Fetch some data from an EOSIO/DFuse endpoint.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:listbw ACCOUNT
List bandwidth for the user account
USAGE
$ uxcli eosio:listbw ACCOUNT
ARGUMENTS
ACCOUNT account to query
OPTIONS
-s, --server=server EOSIO node. Will use `selectedServer` from user config if defined.
DESCRIPTION
...
List bandwidth for the user account
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:listproducers
List block producers
USAGE
$ uxcli eosio:listproducers
OPTIONS
-l, --lower_bound=lower_bound lower bound of query results; used for pagination
-n, --limit=limit [default: 10] number of producers to return
-s, --server=server EOSIO node
DESCRIPTION
...
List block producers
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:regproducer PRODUCER PRODUCER_KEY [URL] [LOCATION]
Register an existing user account as a block producer.
USAGE
$ uxcli eosio:regproducer PRODUCER PRODUCER_KEY [URL] [LOCATION]
ARGUMENTS
PRODUCER account to register as a producer
PRODUCER_KEY public key to use for signing
URL url with information about the producer
LOCATION relative location; for nearest neighbor scheduling
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Register an existing user account as a block producer.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:regproxy PROXY
Register an existing user account as a proxy for voting.
USAGE
$ uxcli eosio:regproxy PROXY
ARGUMENTS
PROXY account to register as a proxy
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Register an existing user account as a proxy for voting.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:sellram ACCOUNT BYTES
Buy RAM.
USAGE
$ uxcli eosio:sellram ACCOUNT BYTES
ARGUMENTS
ACCOUNT account receiving tokens for sold RAM
BYTES number of RAM bytes to sell (must be in increments of 1024 on UTX network)
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Buy RAM.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:transfer FROM TO QUANTITY [MEMO]
Transfer tokens from one account to another.
USAGE
$ uxcli eosio:transfer FROM TO QUANTITY [MEMO]
ARGUMENTS
FROM account sending tokens
TO account receiving tokens
QUANTITY amount of tokens to send
MEMO memo attached to the transfer
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Transfer tokens from one account to another.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:undelegatebw FROM RECEIVER UNSTAKE_NET_QUANTITY UNSTAKE_CPU_QUANTITY
Undelegate bandwidth for the user account
USAGE
$ uxcli eosio:undelegatebw FROM RECEIVER UNSTAKE_NET_QUANTITY UNSTAKE_CPU_QUANTITY
ARGUMENTS
FROM account to undelegate from
RECEIVER account to undelegate to
UNSTAKE_NET_QUANTITY token amount to unstake for NET
UNSTAKE_CPU_QUANTITY token amount to unstake for CPU
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Undelegate bandwidth for the user account
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:unregproducer PRODUCER
Unregister an account from being a block producer.
USAGE
$ uxcli eosio:unregproducer PRODUCER
ARGUMENTS
PRODUCER account to register as a producer
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Unregister an account from being a block producer.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:unregproxy PROXY
Register an existing user account as a proxy for voting.
USAGE
$ uxcli eosio:unregproxy PROXY
ARGUMENTS
PROXY account to unregister as a proxy
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Register an existing user account as a proxy for voting.
See code: @titandeveos/wallet-plugin-eosio
uxcli eosio:voteproducer SUBCOMMAND VOTER PRODUCER
Vote to approve or unapprove a producer or proxy.
USAGE
$ uxcli eosio:voteproducer SUBCOMMAND VOTER PRODUCER
ARGUMENTS
SUBCOMMAND specify the subcommand to use: [prods, proxy, approve, unapprove]. see help for more info.
VOTER account used to vote for a producer
PRODUCER producer (or proxy) to vote for (existing votes will not be changed)
OPTIONS
-b, --[no-]broadcast broadcast transaction after signing
-c, --chainid=chainid Chain ID to use for signing (for accounts on multiple chains)
-k, --key=key key used to sign the transaction (index/public/private: if public must exist in wallet)
-o, --outfile=outfile absolute path to file to output the signed transaction
-p, --permission=permission account@permission used to sign transaction. default permission is "actor@active" if not
supplied.
DESCRIPTION
...
Vote for producers or set a voting proxy.
Subcommands: [prods, proxy, approve, unapprove]
- 'proxy': Vote your stake through a proxy
- 'prods': Vote for one or more producers
- 'approve': Add one producer to list of voted producers
- 'unapprove': Remove one producer from list of voted producers
See code: @titandeveos/wallet-plugin-eosio
uxcli esr:decode TX
Parse ESR transaction and print the raw result
USAGE
$ uxcli esr:decode TX
ARGUMENTS
TX Transaction in ESR format
OPTIONS
-p, --permission=permission [default: ............1,............2] account@permission used to sign transaction.
-s, --server=server [default: http://localhost:8888] EOSIO node used for fetching ABIs
DESCRIPTION
Parse ESR transaction and print the raw result.
See code: @titandeveos/wallet-plugin-eosio
uxcli esr:encode TX
Encode EOSIO transaction as Singing Request
USAGE
$ uxcli esr:encode TX
ARGUMENTS
TX EOSIO Transaction in JSON format
OPTIONS
-s, --server=server EOSIO node used for fetching ABIs. Defaults to: http://localhost:8888
DESCRIPTION
Encode EOSIO transaction as Singing Request.
See code: @titandeveos/wallet-plugin-eosio
uxcli help [COMMAND]
display help for uxcli
USAGE
$ uxcli help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
uxcli keys:add KEY
Add keys to the wallet store
USAGE
$ uxcli keys:add KEY
ARGUMENTS
KEY public/private key to add to the wallet store
DESCRIPTION
The keys:add command is used to add new keys to the current wallet store.
See code: src/commands/keys/add.js
uxcli keys:derive [ROLE] [INDEX]
Create new public/private key pairs from the wallets mnemonic phrase
USAGE
$ uxcli keys:derive [ROLE] [INDEX]
ARGUMENTS
ROLE (owner|active|custom) [default: owner] the role of the key to derive
INDEX [default: 0] the derivation path of the first key
OPTIONS
-c, --count=count [default: 1] the number of keys to generate
DESCRIPTION
The keys:derive command is used to derive key pairs from the wallets mnemonic phrase
See code: src/commands/keys/derive.js
uxcli keys:list
List keys that are in the wallet store
USAGE
$ uxcli keys:list
DESCRIPTION
The keys:list command is used to list the existing keys in the wallet store
See code: src/commands/keys/list.js
uxcli keys:remove KEY
Remove keys from the wallet store
USAGE
$ uxcli keys:remove KEY
ARGUMENTS
KEY public/private key to add to the wallet store
DESCRIPTION
The keys:remove command is used to remove new keys to the current wallet store.
See code: src/commands/keys/remove.js
uxcli logs
View the UX wallet logs
USAGE
$ uxcli logs
OPTIONS
-c, --clear clear (delete) the log files after printing
-n, --lines=lines [default: 20] number of lines to output
-t, --tail tail logs (keep process running and watch logs file)
DESCRIPTION
The logs command will allow you to view the UX wallet logs.
See code: src/commands/logs.js
uxcli plugins
List installed plugins.
USAGE
$ uxcli plugins
OPTIONS
--core Show core plugins.
EXAMPLE
$ uxcli plugins
See code: @oclif/plugin-plugins
uxcli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ uxcli plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
OPTIONS
-h, --help Show CLI help.
-v, --verbose
EXAMPLE
$ uxcli plugins:inspect myplugin
See code: @oclif/plugin-plugins
uxcli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ uxcli plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
OPTIONS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ uxcli plugins:add
EXAMPLES
$ uxcli plugins:install myplugin
$ uxcli plugins:install https://github.com/someuser/someplugin
$ uxcli plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
uxcli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ uxcli plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLE
$ uxcli plugins:link myplugin
See code: @oclif/plugin-plugins
uxcli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ uxcli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help Show CLI help.
-v, --verbose
ALIASES
$ uxcli plugins:unlink
$ uxcli plugins:remove
See code: @oclif/plugin-plugins
uxcli plugins:update
Update installed plugins.
USAGE
$ uxcli plugins:update
OPTIONS
-h, --help Show CLI help.
-v, --verbose
See code: @oclif/plugin-plugins
uxcli service:start
Start the UX Wallet service
USAGE
$ uxcli service:start
OPTIONS
-b, --background run service in the background
-d, --dataDir=dataDir the data directory to start the UX service with
DESCRIPTION
The service:start command will start the currently running UX Wallet service and return its PID.
See code: src/commands/service/start.js
uxcli service:stop
Stop the UX Wallet service
USAGE
$ uxcli service:stop
DESCRIPTION
The service:stop command will stop the currently running UX Wallet service and return the status.
See code: src/commands/service/stop.js
uxcli status
Output useful status information related to the UX wallet
USAGE
$ uxcli status
DESCRIPTION
The status command will tell the user if the UX service is running,
if the wallet is unlocked, and which wallet is currently set as active.
See code: src/commands/status.js
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago