Skip to content

Latest commit

 

History

History
382 lines (266 loc) · 8.57 KB

README.md

File metadata and controls

382 lines (266 loc) · 8.57 KB
Raw

mdrs-util

Command-Line Utility (CLI) for generating reports for the Mars Desert Research Station (MDRS)

GitHub license

Usage

$ npm install -g mdrs-util
$ mdrs-util COMMAND
running command...
$ mdrs-util (--version)
mdrs-util/0.0.0 linux-x64 node-v20.11.1
$ mdrs-util --help [COMMAND]
USAGE
  $ mdrs-util COMMAND
...

Commands

mdrs-util hello PERSON

Say hello

USAGE
  $ mdrs-util hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ oex hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: src/commands/hello/index.ts

mdrs-util hello world

Say hello world

USAGE
  $ mdrs-util hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ mdrs-util hello world
  hello world! (./src/commands/hello/world.ts)

See code: src/commands/hello/world.ts

mdrs-util help [COMMAND]

Display help for mdrs-util.

USAGE
  $ mdrs-util 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 mdrs-util.

See code: @oclif/plugin-help

mdrs-util plugins

List installed plugins.

USAGE
  $ mdrs-util plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ mdrs-util plugins

See code: @oclif/plugin-plugins

mdrs-util plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ mdrs-util plugins add plugins:install PLUGIN...

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

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
  $ mdrs-util plugins add

EXAMPLES
  $ mdrs-util plugins add myplugin 

  $ mdrs-util plugins add https://github.com/someuser/someplugin

  $ mdrs-util plugins add someuser/someplugin

mdrs-util plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ mdrs-util 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
  $ mdrs-util plugins inspect myplugin

See code: @oclif/plugin-plugins

mdrs-util plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ mdrs-util plugins install PLUGIN...

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -s, --silent   Silences yarn output.
  -v, --verbose  Show verbose yarn output.

GLOBAL FLAGS
  --json  Format output as json.

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
  $ mdrs-util plugins add

EXAMPLES
  $ mdrs-util plugins install myplugin 

  $ mdrs-util plugins install https://github.com/someuser/someplugin

  $ mdrs-util plugins install someuser/someplugin

See code: @oclif/plugin-plugins

mdrs-util plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ mdrs-util plugins link PLUGIN

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
  $ mdrs-util plugins link myplugin

See code: @oclif/plugin-plugins

mdrs-util plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ mdrs-util plugins remove plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mdrs-util plugins unlink
  $ mdrs-util plugins remove

EXAMPLES
  $ mdrs-util plugins remove myplugin

mdrs-util plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ mdrs-util 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

mdrs-util plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ mdrs-util plugins uninstall PLUGIN...

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mdrs-util plugins unlink
  $ mdrs-util plugins remove

EXAMPLES
  $ mdrs-util plugins uninstall myplugin

See code: @oclif/plugin-plugins

mdrs-util plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ mdrs-util plugins unlink plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ mdrs-util plugins unlink
  $ mdrs-util plugins remove

EXAMPLES
  $ mdrs-util plugins unlink myplugin

mdrs-util plugins update

Update installed plugins.

USAGE
  $ mdrs-util plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins