oclif example Hello World CLI
$ npm install -g @superkeyio/block-gobbler
$ block-gobbler COMMAND
running command...
$ block-gobbler (--version)
@superkeyio/block-gobbler/0.0.0 darwin-x64 node-v16.15.0
$ block-gobbler --help [COMMAND]
USAGE
$ block-gobbler COMMAND
...block-gobbler blocksblock-gobbler events [FILE]block-gobbler gettersblock-gobbler help [COMMAND]block-gobbler pluginsblock-gobbler plugins:install PLUGIN...block-gobbler plugins:inspect PLUGIN...block-gobbler plugins:install PLUGIN...block-gobbler plugins:link PLUGINblock-gobbler plugins:uninstall PLUGIN...block-gobbler plugins:uninstall PLUGIN...block-gobbler plugins:uninstall PLUGIN...block-gobbler plugins update
describe the command here
USAGE
$ block-gobbler blocks --rpc <value>
FLAGS
--rpc=<value> (required)
DESCRIPTION
describe the command here
See code: dist/commands/blocks.ts
describe the command here
USAGE
$ block-gobbler events [FILE] --rpc <value> --address <value> --event <value> [--startBlock <value>]
[--endBlock <value>] [--confirmations <value>] [--abiFile <value>] [--abi <value>] [--maxBlockRange <value>]
[--concurrency <value>]
FLAGS
--abi=<value>
--abiFile=<value>
--address=<value> (required)
--concurrency=<value> [default: 100]
--confirmations=<value> [default: 12]
--endBlock=<value>
--event=<value> (required)
--maxBlockRange=<value> [default: 10000] Max block range supported by RPC node's eth_getLogs
--rpc=<value> (required)
--startBlock=<value>
DESCRIPTION
describe the command here
See code: dist/commands/events.ts
describe the command here
USAGE
$ block-gobbler getters --rpc <value> --address <value> -g <value> [--startBlock <value>] [--endBlock
<value>] [--confirmations <value>] [--abiFile <value>] [--abi <value>] [--batchSize <value>] [--concurrency <value>]
FLAGS
-g, --getter=<value> (required)
--abi=<value>
--abiFile=<value>
--address=<value> (required)
--batchSize=<value> [default: 10]
--concurrency=<value> [default: 100]
--confirmations=<value> [default: 12]
--endBlock=<value>
--rpc=<value> (required)
--startBlock=<value>
DESCRIPTION
describe the command here
See code: dist/commands/getters.ts
Display help for block-gobbler.
USAGE
$ block-gobbler 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 block-gobbler.
See code: @oclif/plugin-help
List installed plugins.
USAGE
$ block-gobbler plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ block-gobbler plugins
See code: @oclif/plugin-plugins
Installs a plugin into the CLI.
USAGE
$ block-gobbler 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
$ block-gobbler plugins add
EXAMPLES
$ block-gobbler plugins:install myplugin
$ block-gobbler plugins:install https://github.com/someuser/someplugin
$ block-gobbler plugins:install someuser/someplugin
Displays installation properties of a plugin.
USAGE
$ block-gobbler 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
$ block-gobbler plugins:inspect myplugin
Installs a plugin into the CLI.
USAGE
$ block-gobbler 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
$ block-gobbler plugins add
EXAMPLES
$ block-gobbler plugins:install myplugin
$ block-gobbler plugins:install https://github.com/someuser/someplugin
$ block-gobbler plugins:install someuser/someplugin
Links a plugin into the CLI for development.
USAGE
$ block-gobbler 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
$ block-gobbler plugins:link myplugin
Removes a plugin from the CLI.
USAGE
$ block-gobbler plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ block-gobbler plugins unlink
$ block-gobbler plugins remove
Removes a plugin from the CLI.
USAGE
$ block-gobbler plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ block-gobbler plugins unlink
$ block-gobbler plugins remove
Removes a plugin from the CLI.
USAGE
$ block-gobbler plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ block-gobbler plugins unlink
$ block-gobbler plugins remove
Update installed plugins.
USAGE
$ block-gobbler plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.