ethbox
Ethereum CLI toolkit
- Usage
- Commands <!-- tocstop -->
- Usage
- Commands <!-- tocstop -->
- Usage
- Commands
<!-- tocstop -->
# Usage
<!-- usage -->
sh-session $ npm install -g ethbox-cli $ ethbox COMMAND running command... $ ethbox (--version) ethbox-cli/0.0.6 win32-x64 node-v22.13.1 $ ethbox --help [COMMAND] USAGE $ ethbox COMMAND ...<!-- usagestop -->sh-session $ npm install -g ethbox-cli $ ethbox COMMAND running command... $ ethbox (--version) ethbox-cli/0.0.3 win32-x64 node-v22.13.1 $ ethbox --help [COMMAND] USAGE $ ethbox COMMAND ...<!-- usagestop -->sh-session $ npm install -g ethbox-cli $ ethbox COMMAND running command... $ ethbox (--version) ethbox-cli/0.0.2 linux-x64 node-v20.19.0 $ ethbox --help [COMMAND] USAGE $ ethbox COMMAND ...<!-- usagestop --> # Commands <!-- commands --> ethbox auth login PRIVATEKEYethbox help [COMMAND]ethbox pluginsethbox plugins add PLUGINethbox plugins:inspect PLUGIN...ethbox plugins install PLUGINethbox plugins link PATHethbox plugins remove [PLUGIN]ethbox plugins resetethbox plugins uninstall [PLUGIN]ethbox plugins unlink [PLUGIN]ethbox plugins updateethbox tx send AMOUNT TOethbox wallet createethbox wallet inspect ADDRESS
ethbox auth login PRIVATEKEY
Login to your wallet using your private key
USAGE
$ ethbox auth login PRIVATEKEY
ARGUMENTS
PRIVATEKEY the private key to login with
DESCRIPTION
Login to your wallet using your private key
See code: src/commands/auth/login.ts
ethbox help [COMMAND]
Display help for ethbox.
USAGE
$ ethbox 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 ethbox.
See code: @oclif/plugin-help
ethbox plugins
List installed plugins.
USAGE
$ ethbox plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ethbox plugins
See code: @oclif/plugin-plugins
ethbox plugins add PLUGIN
Installs a plugin into ethbox.
USAGE
$ ethbox plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into ethbox.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the ETHBOX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the ETHBOX_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ ethbox plugins add
EXAMPLES
Install a plugin from npm registry.
$ ethbox plugins add myplugin
Install a plugin from a github url.
$ ethbox plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ ethbox plugins add someuser/someplugin
ethbox plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ ethbox plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ ethbox plugins inspect myplugin
See code: @oclif/plugin-plugins
ethbox plugins install PLUGIN
Installs a plugin into ethbox.
USAGE
$ ethbox plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into ethbox.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the ETHBOX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the ETHBOX_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ ethbox plugins add
EXAMPLES
Install a plugin from npm registry.
$ ethbox plugins install myplugin
Install a plugin from a github url.
$ ethbox plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ ethbox plugins install someuser/someplugin
See code: @oclif/plugin-plugins
ethbox plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ ethbox plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
$ ethbox plugins link myplugin
See code: @oclif/plugin-plugins
ethbox plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins remove myplugin
ethbox plugins reset
Remove all user-installed and linked plugins.
USAGE
$ ethbox plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
See code: @oclif/plugin-plugins
ethbox plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins uninstall myplugin
See code: @oclif/plugin-plugins
ethbox plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins unlink myplugin
ethbox plugins update
Update installed plugins.
USAGE
$ ethbox plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
ethbox tx send AMOUNT TO
Send a transaction to an address
USAGE
$ ethbox tx send AMOUNT TO
ARGUMENTS
AMOUNT the amount to send
TO the address to send to
DESCRIPTION
Send a transaction to an address
See code: src/commands/tx/send.ts
ethbox wallet create
Create a new wallet with a random address
USAGE
$ ethbox wallet create
DESCRIPTION
Create a new wallet with a random address
See code: src/commands/wallet/create.ts
ethbox wallet inspect ADDRESS
Search Wallet for Data
USAGE
$ ethbox wallet inspect ADDRESS
ARGUMENTS
ADDRESS the address to search
DESCRIPTION
Search Wallet for Data
See code: src/commands/wallet/inspect.ts
ethbox auth login PRIVATEKEYethbox help [COMMAND]ethbox pluginsethbox plugins add PLUGINethbox plugins:inspect PLUGIN...ethbox plugins install PLUGINethbox plugins link PATHethbox plugins remove [PLUGIN]ethbox plugins resetethbox plugins uninstall [PLUGIN]ethbox plugins unlink [PLUGIN]ethbox plugins updateethbox tx send AMOUNT TOethbox wallet createethbox wallet inspect ADDRESS
ethbox auth login PRIVATEKEY
Login to your wallet using your private key
USAGE
$ ethbox auth login PRIVATEKEY
ARGUMENTS
PRIVATEKEY the private key to login with
DESCRIPTION
Login to your wallet using your private key
See code: src/commands/auth/login.ts
ethbox help [COMMAND]
Display help for ethbox.
USAGE
$ ethbox 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 ethbox.
See code: @oclif/plugin-help
ethbox plugins
List installed plugins.
USAGE
$ ethbox plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ethbox plugins
See code: @oclif/plugin-plugins
ethbox plugins add PLUGIN
Installs a plugin into ethbox.
USAGE
$ ethbox plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into ethbox.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the ETHBOX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the ETHBOX_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ ethbox plugins add
EXAMPLES
Install a plugin from npm registry.
$ ethbox plugins add myplugin
Install a plugin from a github url.
$ ethbox plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ ethbox plugins add someuser/someplugin
ethbox plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ ethbox plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ ethbox plugins inspect myplugin
See code: @oclif/plugin-plugins
ethbox plugins install PLUGIN
Installs a plugin into ethbox.
USAGE
$ ethbox plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into ethbox.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the ETHBOX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the ETHBOX_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ ethbox plugins add
EXAMPLES
Install a plugin from npm registry.
$ ethbox plugins install myplugin
Install a plugin from a github url.
$ ethbox plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ ethbox plugins install someuser/someplugin
See code: @oclif/plugin-plugins
ethbox plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ ethbox plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
$ ethbox plugins link myplugin
See code: @oclif/plugin-plugins
ethbox plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins remove myplugin
ethbox plugins reset
Remove all user-installed and linked plugins.
USAGE
$ ethbox plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
See code: @oclif/plugin-plugins
ethbox plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins uninstall myplugin
See code: @oclif/plugin-plugins
ethbox plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins unlink myplugin
ethbox plugins update
Update installed plugins.
USAGE
$ ethbox plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
ethbox tx send AMOUNT TO
Send a transaction to an address
USAGE
$ ethbox tx send AMOUNT TO
ARGUMENTS
AMOUNT the amount to send
TO the address to send to
DESCRIPTION
Send a transaction to an address
See code: src/commands/tx/send.ts
ethbox wallet create
Create a new wallet with a random address
USAGE
$ ethbox wallet create
DESCRIPTION
Create a new wallet with a random address
See code: src/commands/wallet/create.ts
ethbox wallet inspect ADDRESS
Search Wallet for Data
USAGE
$ ethbox wallet inspect ADDRESS
ARGUMENTS
ADDRESS the address to search
DESCRIPTION
Search Wallet for Data
See code: src/commands/wallet/inspect.ts
ethbox hello PERSONethbox hello worldethbox help [COMMAND]ethbox pluginsethbox plugins add PLUGINethbox plugins:inspect PLUGIN...ethbox plugins install PLUGINethbox plugins link PATHethbox plugins remove [PLUGIN]ethbox plugins resetethbox plugins uninstall [PLUGIN]ethbox plugins unlink [PLUGIN]ethbox plugins updateethbox wallet createethbox wallet inspect ADDRESS
ethbox hello PERSON
Say hello
USAGE
$ ethbox hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ ethbox hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: src/commands/hello/index.ts
ethbox hello world
Say hello world
USAGE
$ ethbox hello world
DESCRIPTION
Say hello world
EXAMPLES
$ ethbox hello world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/hello/world.ts
ethbox help [COMMAND]
Display help for ethbox.
USAGE
$ ethbox 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 ethbox.
See code: @oclif/plugin-help
ethbox plugins
List installed plugins.
USAGE
$ ethbox plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ ethbox plugins
See code: @oclif/plugin-plugins
ethbox plugins add PLUGIN
Installs a plugin into ethbox.
USAGE
$ ethbox plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into ethbox.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the ETHBOX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the ETHBOX_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ ethbox plugins add
EXAMPLES
Install a plugin from npm registry.
$ ethbox plugins add myplugin
Install a plugin from a github url.
$ ethbox plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ ethbox plugins add someuser/someplugin
ethbox plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ ethbox plugins inspect PLUGIN...
ARGUMENTS
PLUGIN... [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ ethbox plugins inspect myplugin
See code: @oclif/plugin-plugins
ethbox plugins install PLUGIN
Installs a plugin into ethbox.
USAGE
$ ethbox plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
ARGUMENTS
PLUGIN... Plugin to install.
FLAGS
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
-h, --help Show CLI help.
-s, --silent Silences npm output.
-v, --verbose Show verbose npm output.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
Installs a plugin into ethbox.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the ETHBOX_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the ETHBOX_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ ethbox plugins add
EXAMPLES
Install a plugin from npm registry.
$ ethbox plugins install myplugin
Install a plugin from a github url.
$ ethbox plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ ethbox plugins install someuser/someplugin
See code: @oclif/plugin-plugins
ethbox plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ ethbox plugins link PATH [-h] [--install] [-v]
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
--[no-]install Install dependencies after linking the plugin.
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
$ ethbox plugins link myplugin
See code: @oclif/plugin-plugins
ethbox plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins remove [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins remove myplugin
ethbox plugins reset
Remove all user-installed and linked plugins.
USAGE
$ ethbox plugins reset [--hard] [--reinstall]
FLAGS
--hard Delete node_modules and package manager related files in addition to uninstalling plugins.
--reinstall Reinstall all plugins after uninstalling.
See code: @oclif/plugin-plugins
ethbox plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins uninstall [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins uninstall myplugin
See code: @oclif/plugin-plugins
ethbox plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ ethbox plugins unlink [PLUGIN...] [-h] [-v]
ARGUMENTS
PLUGIN... plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ ethbox plugins unlink
$ ethbox plugins remove
EXAMPLES
$ ethbox plugins unlink myplugin
ethbox plugins update
Update installed plugins.
USAGE
$ ethbox plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
ethbox wallet create
Create a new wallet with a random address
USAGE
$ ethbox wallet create
DESCRIPTION
Create a new wallet with a random address
See code: src/commands/wallet/create.ts
ethbox wallet inspect ADDRESS
Search Wallet for Data
USAGE
$ ethbox wallet inspect ADDRESS
ARGUMENTS
ADDRESS the address to search
DESCRIPTION
Search Wallet for Data
See code: src/commands/wallet/inspect.ts
Log in or sign up for Devpost to join the conversation.