nba-tools
v0.3.0
Published
A CLI with various commands related to the @LMaxence/nba project
Downloads
3
Readme
oclif-hello-world
oclif example Hello World CLI
Usage
$ npm install -g nba-tools
$ nbatls COMMAND
running command...
$ nbatls (--version)
nba-tools/0.3.0 darwin-arm64 node-v16.13.1
$ nbatls --help [COMMAND]
USAGE
$ nbatls COMMAND
...
Commands
nbatls db build
nbatls db update
nbatls help [COMMAND]
nbatls plugins
nbatls plugins:inspect PLUGIN...
nbatls plugins:install PLUGIN...
nbatls plugins:link PLUGIN
nbatls plugins:uninstall PLUGIN...
nbatls plugins update
nbatls db build
Fetch NBA data and store them into a database
USAGE
$ nbatls db build [-s <value>]
FLAGS
-s, --from=<value> [default: 2021-10-01] The date from when to download data, under the format YYYY-MM-DD.
DESCRIPTION
Fetch NBA data and store them into a database
EXAMPLES
$ nbatls db build
nbatls db update
Fetch NBA data and store them into a database
USAGE
$ nbatls db update [-s <value>]
FLAGS
-s, --startDate=<value> The date from when to download data, under the format YYYY-MM-DD.
DESCRIPTION
Fetch NBA data and store them into a database
EXAMPLES
$ nbatls db update
nbatls help [COMMAND]
Display help for nbatls.
USAGE
$ nbatls 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 nbatls.
See code: @oclif/plugin-help
nbatls plugins
List installed plugins.
USAGE
$ nbatls plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ nbatls plugins
See code: @oclif/plugin-plugins
nbatls plugins:inspect PLUGIN...
Displays installation properties of a plugin.
USAGE
$ nbatls 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
$ nbatls plugins:inspect myplugin
nbatls plugins:install PLUGIN...
Installs a plugin into the CLI.
USAGE
$ nbatls 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
$ nbatls plugins add
EXAMPLES
$ nbatls plugins:install myplugin
$ nbatls plugins:install https://github.com/someuser/someplugin
$ nbatls plugins:install someuser/someplugin
nbatls plugins:link PLUGIN
Links a plugin into the CLI for development.
USAGE
$ nbatls 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
$ nbatls plugins:link myplugin
nbatls plugins:uninstall PLUGIN...
Removes a plugin from the CLI.
USAGE
$ nbatls plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ nbatls plugins unlink
$ nbatls plugins remove
nbatls plugins update
Update installed plugins.
USAGE
$ nbatls plugins update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.