How To Use the Package CLI to Generate a Package

To get started, make sure you can access the hxpkg.exe tool:

In PowerShell, run hkpkg.exe:

$hxpkg = $env:HyperXInstall + '\Executable\hxpkg.exe'
& $hxpkg

hxpkg.exe Output:

hxpkg 1.0.0+ b4b79e2d64c803f8bce3a76dbc2f5fcdb7b3d681
Copyright (C) 2025 hxpkg

ERROR(S) :
No verb selected.

add             Add to a package.
cache clean     Clean the package cache.
cache install   Install a package to the cache.
package         Create a package.
init            Initialize a new package.
isolate         Isolate a package module into its own package.
help            Display more information on a specific command.
version         Display version information.

If you cannot access the hxpkg.exe tool, your HyperXInstall environment variable might not be set. You can set it to the directory that HyperX installs to and try again. For instance:

In PowerShell, run hkpkg.exe:

$env:HyperXInstall = $env:LOCALAPPDATA + '\Programs\HyperX'; #modify as necessary to point to your install location
$hxpkg = $env:HyperXInstall + '\Executable\hxpkg.exe'
& $hxpkg

Once you can access the hxpkg.exe tool, initialize a new Package and add Modules to it.

PowerShell: Initialize Command:

& $hxpkg init
& $hxpkg add script
tree /f /a

Generated Initialize Files:

C:.
|    changelog.md
|    hxpkg.yaml
|    readme.md

\---modules
    \---script
            changelog.md
            readme.md
            script.py

Finally, package it all up into a .hxpkg Package file.

& $hxpkg package
tree /f /a

Generated Package File:

C:.
|    changelog.md
|    hxpkg.yaml
|    readme.md
|
+---build
|    generated.package.CHANGEME.0.0.0.hxpkg < New!
\---modules
    \---script
            changelog.md
            readme.md
            script.py

You can install the Package in HyperX via the Package Manager by: