Skip to main content
  1. HyperX Support
  2. Scripting
  3. Packages

How To Build a Script Package

Building a Package, in other words, creating a .hxpkg file that HyperX can interact with, requires using the hxpkg.exe Package Command Line Interface (CLI). This tool is provided with the HyperX installation.

Prerequisite

This workflow assumes that you already have a Package defined with a Package Configuration File. There are three ways to create a Package and Configuration File:

Step #1 Open the Package CLI

First, locate your hxpkg.exe file. This is typically located at the following path: $(HyperXInstallDirectory)/Executable/hxpkg.exe

Then, open a command prompt in the hxpkg.exe directory and run the tool. You should see a list of the tool’s subcommands.

buildPackage_testExe.png

Step #2: Build Package

If that works, run the tool with the following options:

hxpkg.exe package <INPUT DIRECTORY> -o <OUTPUT DIRECTORY>

If you have several Configuration Files in this directory or if your Configuration File is named something other than hxpkg.yaml, you can use the ‘-c’ option to specify which Configuration File to use. For example:

hxpkg.exe package -i "C:\Dev\Scripts\HyperX" -o "C:\Desktop" -c hxpkg-sample.yaml

If the command was successful, you will be able to see the newly created .hxpkg file at the output file destination specified in the command; in the example above, this would be C:\Desktop.

Tip

You can view additional information about Packaging with the hxpkg.exe tool by supplying the ‘package –help’ options when calling the Packaging Tool.

hxpkg.exe package --help

Recently Viewed

Didn’t find what you’re looking for?

Submit a Request

Didn’t find what you’re looking for?

Create a New Post