@theutz/hlp v0.1.0

help

Shortcuts to my favorite help locations

• Usage
• Commands

Usage

$ npm install -g @theutz/hlp
$ hlp COMMAND
running command...
$ hlp (--version)
@theutz/hlp/0.1.0 darwin-arm64 node-v20.16.0
$ hlp --help [COMMAND]
USAGE
  $ hlp COMMAND
...

Commands

• hlp add SOURCE ACTION
• hlp help [COMMAND]
• hlp plugins
• hlp plugins add PLUGIN
• hlp plugins:inspect PLUGIN...
• hlp plugins install PLUGIN
• hlp plugins link PATH
• hlp plugins remove [PLUGIN]
• hlp plugins reset
• hlp plugins uninstall [PLUGIN]
• hlp plugins unlink [PLUGIN]
• hlp plugins update
• hlp with [SOURCE]

hlp add SOURCE ACTION

add a new source to use with the with command

USAGE
  $ hlp add SOURCE... ACTION...

ARGUMENTS
  SOURCE...  name to use for the source
  ACTION...  action to take with source

DESCRIPTION
  add a new source to use with the `with` command

EXAMPLES
  $ hlp add

See code: src/commands/add.ts

hlp help [COMMAND]

Display help for hlp.

USAGE
  $ hlp 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 hlp.

See code: @oclif/plugin-help

hlp plugins

List installed plugins.

USAGE
  $ hlp plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ hlp plugins

See code: @oclif/plugin-plugins

hlp plugins add PLUGIN

Installs a plugin into hlp.

USAGE
  $ hlp 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 hlp.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the HLP_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the HLP_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ hlp plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ hlp plugins add myplugin

  Install a plugin from a github url.

    $ hlp plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ hlp plugins add someuser/someplugin

hlp plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

hlp plugins install PLUGIN

Installs a plugin into hlp.

USAGE
  $ hlp 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 hlp.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the HLP_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the HLP_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ hlp plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ hlp plugins install myplugin

  Install a plugin from a github url.

    $ hlp plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ hlp plugins install someuser/someplugin

See code: @oclif/plugin-plugins

hlp plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ hlp 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
  $ hlp plugins link myplugin

See code: @oclif/plugin-plugins

hlp plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ hlp 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
  $ hlp plugins unlink
  $ hlp plugins remove

EXAMPLES
  $ hlp plugins remove myplugin

hlp plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ hlp 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

hlp plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ hlp 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
  $ hlp plugins unlink
  $ hlp plugins remove

EXAMPLES
  $ hlp plugins uninstall myplugin

See code: @oclif/plugin-plugins

hlp plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ hlp 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
  $ hlp plugins unlink
  $ hlp plugins remove

EXAMPLES
  $ hlp plugins unlink myplugin

hlp plugins update

Update installed plugins.

USAGE
  $ hlp plugins update [-h] [-v]

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

hlp with [SOURCE]

Choose for help from a list of sources...

USAGE
  $ hlp with [SOURCE...]

DESCRIPTION
  Choose for help from a list of sources...

See code: src/commands/with.ts