0.2.0 • Published 1 year ago
boostdat v0.2.0
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g boostdat
$ boostdat COMMAND
running command...
$ boostdat (--version)
boostdat/0.2.0 darwin-x64 node-v16.13.1
$ boostdat --help [COMMAND]
USAGE
$ boostdat COMMAND
...
Commands
boostdat buy
boostdat help [COMMAND]
boostdat mine
boostdat mine content
boostdat plugins
boostdat plugins:install PLUGIN...
boostdat plugins:inspect PLUGIN...
boostdat plugins:install PLUGIN...
boostdat plugins:link PLUGIN
boostdat plugins:uninstall PLUGIN...
boostdat plugins:uninstall PLUGIN...
boostdat plugins:uninstall PLUGIN...
boostdat plugins update
boostdat stream
boostdat buy
Place An Order To Buy BoostPow
USAGE
$ boostdat buy -c <value> -d <value> -s <value> [-a <value>] [--category <value>] [--tag <value>]
[--miner <value>]
FLAGS
-a, --additionalData=<value> Additional Data
-c, --content=<value> (required) Txid of content to boost
-d, --difficulty=<value> (required) Difficulty for work order
-s, --satoshis=<value> (required) Value paid for job in satoshis
--category=<value> Category will be converted to hex
--miner=<value> Public address of miner for contract
--tag=<value> Tag will be converted to hex
DESCRIPTION
Place An Order To Buy BoostPow
EXAMPLES
$ boostpow buy --content $TXID --difficulty 2.18 --satoshis 10_000_000
$ boostpow buy -c $TXID -d 2.18 -s 10_000_000
See code: dist/commands/buy/index.ts
boostdat help [COMMAND]
Display help for boostdat.
USAGE
$ boostdat help [COMMAND] [-n]
ARGUMENTS
COMMAND Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for boostdat.
See code: @oclif/plugin-help
boostdat mine
Place An Order To Buy BoostPow
USAGE
$ boostdat mine -c <value> -d <value> -s <value> [--category <value>] [--tag <value>] [--miner <value>]
FLAGS
-c, --content=<value> (required) Txid of content to boost
-d, --difficulty=<value> (required) Difficulty for work order
-s, --satoshis=<value> (required) Value paid for job in satoshis
--category=<value> Category will be converted to hex
--miner=<value> Public address of miner for contract
--tag=<value> Tag will be converted to hex
DESCRIPTION
Place An Order To Buy BoostPow
EXAMPLES
$ boostpow buy --content $TXID --difficulty 2.18 --satoshis 10_000_000
$ boostpow buy -c $TXID -d 2.18 -s 10_000_000
See code: dist/commands/mine/index.ts
boostdat mine content
Bu and Then Mine Boost for Specific Content
USAGE
$ boostdat mine content
DESCRIPTION
Bu and Then Mine Boost for Specific Content
EXAMPLES
$ boostdat mine content -content $TXID --satoshis 100000 --difficulty 0.1 --tag productivity --forever
boostdat plugins
List installed plugins.
USAGE
$ boostdat plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ boostdat plugins
See code: @oclif/plugin-plugins
boostdat plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ boostdat plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
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
$ boostdat plugins add
EXAMPLES
$ boostdat plugins:install myplugin
$ boostdat plugins:install https://github.com/someuser/someplugin
$ boostdat plugins:install someuser/someplugin
boostdat plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ boostdat plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ boostdat plugins:inspect myplugin
boostdat plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ boostdat plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
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
$ boostdat plugins add
EXAMPLES
$ boostdat plugins:install myplugin
$ boostdat plugins:install https://github.com/someuser/someplugin
$ boostdat plugins:install someuser/someplugin
boostdat plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ boostdat plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
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.
EXAMPLES
$ boostdat plugins:link myplugin
boostdat plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ boostdat plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ boostdat plugins unlink
$ boostdat plugins remove
boostdat plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ boostdat plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ boostdat plugins unlink
$ boostdat plugins remove
boostdat plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ boostdat plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ boostdat plugins unlink
$ boostdat plugins remove
boostdat plugins update
Update installed plugins.
USAGE
$ boostdat plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
boostdat stream
Stream New Boostpow Jobs & Proofs
USAGE
$ boostdat stream [--json]
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Stream New Boostpow Jobs & Proofs
EXAMPLES
$ boostpow sync
See code: dist/commands/stream/index.ts
0.2.0
1 year ago