@yongenaelf/oclif-cli-aelf
v2.1.0
Published
Command-line interface for the aelf blockchain.
Downloads
12
Readme
oclif-cli-aelf
Command-line interface for the aelf blockchain.
Usage
$ npm install -g @yongenaelf/oclif-cli-aelf
$ aelf COMMAND
running command...
$ aelf (--version)
@yongenaelf/oclif-cli-aelf/2.1.0 darwin-arm64 node-v22.4.0
$ aelf --help [COMMAND]
USAGE
$ aelf COMMAND
...
Commands
aelf audit
aelf build [FILE]
aelf deploy [FILE]
aelf export [FILE]
aelf hello PERSON
aelf hello world
aelf help [COMMAND]
aelf plugins
aelf plugins add PLUGIN
aelf plugins:inspect PLUGIN...
aelf plugins install PLUGIN
aelf plugins link PATH
aelf plugins remove [PLUGIN]
aelf plugins reset
aelf plugins uninstall [PLUGIN]
aelf plugins unlink [PLUGIN]
aelf plugins update
aelf audit
ai audit
USAGE
$ aelf audit [-d <value>]
FLAGS
-d, --directory=<value> Specify a directory to list files from
DESCRIPTION
ai audit
EXAMPLES
$ aelf audit
See code: src/commands/audit.ts
aelf build [FILE]
describe the command here
USAGE
$ aelf build [FILE] [-f] [-n <value>]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ aelf build
See code: src/commands/build.ts
aelf deploy [FILE]
describe the command here
USAGE
$ aelf deploy [FILE] [-f] [-n <value>]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ aelf deploy
See code: src/commands/deploy.ts
aelf export [FILE]
describe the command here
USAGE
$ aelf export [FILE] [-f] [-n <value>]
ARGUMENTS
FILE file to read
FLAGS
-f, --force
-n, --name=<value> name to print
DESCRIPTION
describe the command here
EXAMPLES
$ aelf export
See code: src/commands/export.ts
aelf hello PERSON
Say hello
USAGE
$ aelf hello PERSON -f <value>
ARGUMENTS
PERSON Person to say hello to
FLAGS
-f, --from=<value> (required) Who is saying hello
DESCRIPTION
Say hello
EXAMPLES
$ aelf hello friend --from oclif
hello friend from oclif! (./src/commands/hello/index.ts)
See code: src/commands/hello/index.ts
aelf hello world
Say hello world
USAGE
$ aelf hello world
DESCRIPTION
Say hello world
EXAMPLES
$ aelf hello world
hello world! (./src/commands/hello/world.ts)
See code: src/commands/hello/world.ts
aelf help [COMMAND]
Display help for aelf.
USAGE
$ aelf 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 aelf.
See code: @oclif/plugin-help
aelf plugins
List installed plugins.
USAGE
$ aelf plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ aelf plugins
See code: @oclif/plugin-plugins
aelf plugins add PLUGIN
Installs a plugin into aelf.
USAGE
$ aelf 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 aelf.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the AELF_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the AELF_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ aelf plugins add
EXAMPLES
Install a plugin from npm registry.
$ aelf plugins add myplugin
Install a plugin from a github url.
$ aelf plugins add https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ aelf plugins add someuser/someplugin
aelf plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ aelf 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
$ aelf plugins inspect myplugin
See code: @oclif/plugin-plugins
aelf plugins install PLUGIN
Installs a plugin into aelf.
USAGE
$ aelf 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 aelf.
Uses npm to install plugins.
Installation of a user-installed plugin will override a core plugin.
Use the AELF_NPM_LOG_LEVEL environment variable to set the npm loglevel.
Use the AELF_NPM_REGISTRY environment variable to set the npm registry.
ALIASES
$ aelf plugins add
EXAMPLES
Install a plugin from npm registry.
$ aelf plugins install myplugin
Install a plugin from a github url.
$ aelf plugins install https://github.com/someuser/someplugin
Install a plugin from a github slug.
$ aelf plugins install someuser/someplugin
See code: @oclif/plugin-plugins
aelf plugins link PATH
Links a plugin into the CLI for development.
USAGE
$ aelf 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
$ aelf plugins link myplugin
See code: @oclif/plugin-plugins
aelf plugins remove [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ aelf 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
$ aelf plugins unlink
$ aelf plugins remove
EXAMPLES
$ aelf plugins remove myplugin
aelf plugins reset
Remove all user-installed and linked plugins.
USAGE
$ aelf 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
aelf plugins uninstall [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ aelf 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
$ aelf plugins unlink
$ aelf plugins remove
EXAMPLES
$ aelf plugins uninstall myplugin
See code: @oclif/plugin-plugins
aelf plugins unlink [PLUGIN]
Removes a plugin from the CLI.
USAGE
$ aelf 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
$ aelf plugins unlink
$ aelf plugins remove
EXAMPLES
$ aelf plugins unlink myplugin
aelf plugins update
Update installed plugins.
USAGE
$ aelf plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins