Skip to main content

hmcs mod

List, install, and uninstall MOD packages.

Quick Examples​

hmcs mod list
hmcs mod install @hmcs/assets @hmcs/elmer
hmcs mod uninstall @hmcs/assets

list​

Syntax​

hmcs mod list

Arguments​

This subcommand takes no arguments.

Examples​

Success:

 NAME           VERSION  DESCRIPTION
 @hmcs/elmer    1.0.0    Default character model
 @hmcs/menu     1.0.0    Context menu

No installed MODs:

(no output)

Failure example:

[stderr]
...pnpm ls failed...

Behavior​

  • Lists installed MOD metadata from the configured mods directory.
  • Uses pnpm -C <mods_dir> ls --parseable -P --depth 0 internally.

install​

Syntax​

hmcs mod install <package>...

Arguments​

NameRequiredDescription
packageYesOne or more package specifiers (for example @hmcs/elmer or pkg@version).

Examples​

Success:

hmcs mod install @hmcs/assets @hmcs/elmer

Failure example (invalid package name):

hmcs mod install 'foo;rm -rf /'
[stderr]
invalid package name: contains forbidden characters: foo;rm -rf /

Failure example (pnpm add failed):

[stderr]
pnpm add failed with status: ...

Behavior​

  • Validates package names before calling pnpm.
  • Installs into the configured mods_dir.
  • Exits non-zero on validation or install failure.

uninstall​

Syntax​

hmcs mod uninstall <package>...

Arguments​

NameRequiredDescription
packageYesOne or more installed package names.

Examples​

Success:

hmcs mod uninstall @hmcs/assets @hmcs/elmer

Failure example (invalid package name):

hmcs mod uninstall '../etc/passwd'
[stderr]
invalid package name: contains path traversal: ../etc/passwd

Failure example (pnpm remove failed):

[stderr]
pnpm remove failed with status: ...

Behavior​

  • Validates package names before calling pnpm.
  • Removes packages from the configured mods_dir.
  • Exits non-zero on validation or uninstall failure.