@animus-bi/cli
v1.0.6
Published
HeroDevs NES Developer Kit
Downloads
32
Readme
HeroDevs NES Developer Kit -- @herodevs/cli
Usage
$ npm install -g @animus-bi/cli
$ @herodevs/cli COMMAND
running command...
$ @herodevs/cli (--version)
@animus-bi/cli/1.0.6 darwin-arm64 node-v18.17.1
$ @herodevs/cli --help [COMMAND]
USAGE
$ @herodevs/cli COMMAND
...
Commands
@herodevs/cli committer [GET-ALL]
@herodevs/cli committer:get-all [flags [-s][-e][-x]]
@herodevs/cli help [COMMANDS]
@herodevs/cli plugins
@herodevs/cli plugins:install PLUGIN...
@herodevs/cli plugins:inspect PLUGIN...
@herodevs/cli plugins:install PLUGIN...
@herodevs/cli plugins:link PLUGIN
@herodevs/cli plugins:uninstall PLUGIN...
@herodevs/cli plugins:uninstall PLUGIN...
@herodevs/cli plugins:uninstall PLUGIN...
@herodevs/cli plugins update
@herodevs/cli update verify
@herodevs/cli committer [GET-ALL]
Gets committer info
USAGE
$ @herodevs/cli committer [GET-ALL] [--json] [--log-level debug|info|warn|error]
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> Specify level for logging.
<options: debug|info|warn|error>
DESCRIPTION
Gets committer info
EXAMPLES
$ @herodevs/cli committer
See code: dist/commands/committer/index.ts
@herodevs/cli committer:get-all [flags [-s][-e][-x]]
Get Committers Between Two Dates
USAGE
$ @herodevs/cli committer get-all [flags [-s][-e][-x]]
FLAGS
-e, --endDate=<value> [default: 2022-08-31] End Date (format: yyyy-MM-dd)
-s, --startDate=<value> [default: 2023-08-31] Start Date (format: yyyy-MM-dd)
-x, --exclude=<value>... Path Exclusions (eg -x="./src/bin" -x="./dist")
GLOBAL FLAGS
--json Format output as json.
--log-level=<option> Specify level for logging.
<options: debug|info|warn|error>
EXAMPLES
$ @herodevs/cli committer get-all
See code: dist/commands/committer/get-all.ts
@herodevs/cli help [COMMANDS]
Display help for @herodevs/cli.
USAGE
$ @herodevs/cli help [COMMANDS] [-n]
ARGUMENTS
COMMANDS Command to show help for.
FLAGS
-n, --nested-commands Include all nested commands in the output.
DESCRIPTION
Display help for @herodevs/cli.
See code: @oclif/plugin-help
@herodevs/cli plugins
List installed plugins.
USAGE
$ @herodevs/cli plugins [--json] [--core]
FLAGS
--core Show core plugins.
GLOBAL FLAGS
--json Format output as json.
DESCRIPTION
List installed plugins.
EXAMPLES
$ @herodevs/cli plugins
See code: @oclif/plugin-plugins
@herodevs/cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ @herodevs/cli 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
$ @herodevs/cli plugins add
EXAMPLES
$ @herodevs/cli plugins:install myplugin
$ @herodevs/cli plugins:install https://github.com/someuser/someplugin
$ @herodevs/cli plugins:install someuser/someplugin
@herodevs/cli plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ @herodevs/cli 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
$ @herodevs/cli plugins:inspect myplugin
See code: @oclif/plugin-plugins
@herodevs/cli plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ @herodevs/cli 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
$ @herodevs/cli plugins add
EXAMPLES
$ @herodevs/cli plugins:install myplugin
$ @herodevs/cli plugins:install https://github.com/someuser/someplugin
$ @herodevs/cli plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
@herodevs/cli plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ @herodevs/cli 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
$ @herodevs/cli plugins:link myplugin
See code: @oclif/plugin-plugins
@herodevs/cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ @herodevs/cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ @herodevs/cli plugins unlink
$ @herodevs/cli plugins remove
@herodevs/cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ @herodevs/cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ @herodevs/cli plugins unlink
$ @herodevs/cli plugins remove
See code: @oclif/plugin-plugins
@herodevs/cli plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ @herodevs/cli plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ @herodevs/cli plugins unlink
$ @herodevs/cli plugins remove
@herodevs/cli plugins update
Update installed plugins.
USAGE
$ @herodevs/cli plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
@herodevs/cli update verify
verifies version
USAGE
$ @herodevs/cli update verify
DESCRIPTION
verifies version
EXAMPLES
$ @herodevs/cli update verify
See code: dist/commands/update/verify.ts