Skip to content

herodevs/cli

BranchesTags

Repository files navigation

@herodevs/cli

The HeroDevs CLI

oclif Version Downloads/week

Usage

$ npm install -g @herodevs/cli
$ hd COMMAND
running command...
$ hd (--version)
@herodevs/cli/1.1.0-beta.1 darwin-arm64 node-v22.14.0
$ hd --help [COMMAND]
USAGE
  $ hd COMMAND
...

Commands

hd help [COMMAND]

Display help for hd.

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

See code: @oclif/plugin-help

hd plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ hd plugins

See code: @oclif/plugin-plugins

hd plugins add PLUGIN

Installs a plugin into hd.

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

  Uses npm to install plugins.

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

  Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the HD_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ hd plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ hd plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ hd plugins add someuser/someplugin

hd plugins:inspect PLUGIN...

Displays installation properties of a plugin.

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

See code: @oclif/plugin-plugins

hd plugins install PLUGIN

Installs a plugin into hd.

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

  Uses npm to install plugins.

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

  Use the HD_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the HD_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ hd plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ hd plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ hd plugins install someuser/someplugin

See code: @oclif/plugin-plugins

hd plugins link PATH

Links a plugin into the CLI for development.

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

See code: @oclif/plugin-plugins

hd plugins remove [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ hd plugins remove myplugin

hd plugins reset

Remove all user-installed and linked plugins.

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

hd plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ hd plugins uninstall myplugin

See code: @oclif/plugin-plugins

hd plugins unlink [PLUGIN]

Removes a plugin from the CLI.

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

EXAMPLES
  $ hd plugins unlink myplugin

hd plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

hd report committers

Generate report of committers to a git repository

USAGE
  $ hd report committers [--json] [-m <value>] [-c] [-s]

FLAGS
  -c, --csv             Output in CSV format
  -m, --months=<value>  [default: 12] The number of months of git history to review
  -s, --save            Save the committers report as nes.committers.<output>

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Generate report of committers to a git repository

EXAMPLES
  $ hd report committers

  $ hd report committers --csv -s

  $ hd report committers --json

  $ hd report committers --csv

See code: src/commands/report/committers.ts

hd report purls

Generate a list of purls from a sbom

USAGE
  $ hd report purls [--json] [-f <value>] [-d <value>] [-s] [-c]

FLAGS
  -c, --csv           Save output in CSV format (only applies when using --save)
  -d, --dir=<value>   The directory to scan in order to create a cyclonedx sbom
  -f, --file=<value>  The file path of an existing cyclonedx sbom to scan for EOL
  -s, --save          Save the list of purls as nes.purls.<output>

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Generate a list of purls from a sbom

EXAMPLES
  $ hd report purls --json -s

  $ hd report purls --dir=./my-project

  $ hd report purls --file=path/to/sbom.json

  $ hd report purls --dir=./my-project --save

  $ hd report purls --save --csv

See code: src/commands/report/purls.ts

hd scan eol

Scan a given sbom for EOL data

USAGE
  $ hd scan eol [--json] [-f <value>] [-d <value>] [-s]

FLAGS
  -d, --dir=<value>   The directory to scan in order to create a cyclonedx sbom
  -f, --file=<value>  The file path of an existing cyclonedx sbom to scan for EOL
  -s, --save          Save the generated SBOM as nes.sbom.json in the scanned directory

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Scan a given sbom for EOL data

EXAMPLES
  $ hd scan eol --dir=./my-project

  $ hd scan eol --file=path/to/sbom.json

See code: src/commands/scan/eol.ts

hd scan sbom

Scan a SBOM for purls

USAGE
  $ hd scan sbom [--json] [-f <value>] [-d <value>] [-s] [-b]

FLAGS
  -b, --background    Run the scan in the background
  -d, --dir=<value>   The directory to scan in order to create a cyclonedx sbom
  -f, --file=<value>  The file path of an existing cyclonedx sbom to scan for EOL
  -s, --save          Save the generated SBOM as nes.sbom.json in the scanned directory

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Scan a SBOM for purls

EXAMPLES
  $ hd scan sbom --dir=./my-project

  $ hd scan sbom --file=path/to/sbom.json

See code: src/commands/scan/sbom.ts

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

3 stars

Watchers

4 watching

Forks

5 forks
Report repository

Releases 6

Release v0.3.1 Latest
Dec 18, 2024
+ 5 releases

Packages

No packages published

Contributors 8

Languages