Reference Guide for HGK commands
1. Overview
This document contains a quick overview of all the commands offered by hgk version 2026.6.0.
2. Help menu
Simply run the following hgk command to retrieve the help menu. See output below.
hgk
Usage: hgk [-h | --help] [SUB-COMMAND] [SUB-COMMAND-ARGS]
Helix Groundkit is a development kit for spacecraft ground software
Command arguments:
--help, -h : display this help menu
--version : display version information
Available sub-commands:
board : Generate resources for boards
bundle : Commands for managing bundles
component-type : Create, delete and generate code for component types
deployment-type : Create and generate documentation for deployment types
mission : Create, generate, and build missions and their documentation
module : Create, delete and generate code for modules
osal : Generate resources for osals
service : Create, delete and generate code for services
workspace : Create, delete and manipulate workspaces and bundles
3. Workspaces
| Task | Command |
|---|---|
Build a Workspace (builds all artefacts, runs all unit tests) |
hgk workspace build |
Create a Workspace |
hgk workspace create <name> |
Delete a Workspace |
Not implemented |
Generate documentation for a Workspace |
hgk workspace generate-docs |
Prepare the current Workspace |
hgk workspace prepare |
Bundle the current Workspace |
hgk workspace bundle generate <MAJOR.MINOR.PATCH> <output directory> Example: hgk workspace bundle generate 0.0.1 . |
Import a Helix Bundle into your current Workspace |
hgk workspace bundle require <name>:<MAJOR.MINOR.PATCH> Example: hgk workspace bundle require GroundkitFoundation:7.2.0 |
4. Bundles
| Task | Command |
|---|---|
Generate documentation for a Bundle |
hgk bundle generate-docs Example: hgk bundle generate-docs /path/to/GroundkitFoundation_7_2_0.tar.gz <Output Directory> Example: hgk bundle generate-docs GroundkitFoundation:7.2.0 <Output Directory> |
Install a bundle to your central bundle repository |
hgk bundle install <name>_<MAJOR_MINOR_PATCH>.tar.gz |
List the bundles installed in your bundle repository |
hgk bundle list |
Uninstall a bundle from your central bundle repository |
hgk bundle uninstall <name>:<MAJOR.MINOR.PATCH> |
5. Modules
| Task | Command |
|---|---|
Build a module and run its test |
hgk module build <name> |
Create a Module |
hgk module create <name> |
Delete a Module |
Not implemented |
Generate a Module |
hgk module generate <name> |
Generate documentation for a module in the current Workspace |
hgk module generate-docs <name> |
Generate gRPC resources for a module (protobuf files, gRPC files, serialisation/deserialisation methods) |
hgk module generate-grpc-resources <name> |
6. Services
| Task | Command |
|---|---|
Build a service and run its test |
hgk service build <name> |
Create a Service |
hgk service create <name> |
Delete a Service |
Not implemented |
Generate a Service |
hgk service generate <name> |
Generate documentation for a service in the current Workspace |
hgk service generate-docs <name> |
Generate gRPC resources for a given Service. (protobuf files, gRPC files, serialisation/deserialisation methods) |
hgk service generate-grpc-resources <name> |
7. Components
| Task | Command |
|---|---|
Build a Component and run its test |
hgk component-type build <name> |
Create a Component Type |
hgk component-type create <name> |
Delete a Component |
Not implemented |
Generate a Component |
hgk component-type generate <name> |
Generate documentation for a Component Type in the current Workspace. |
hgk workspace generate-docs |
8. Deployments
| Task | Command |
|---|---|
Create a Deployment Type |
hgk deployment-type create <name> |
Generate documentation for a Deployment Type in the current Workspace. |
hgk deployment-type generate-docs <name> |
9. Missions
| Task | Command |
|---|---|
Build a Mission |
hgk mission build <name> |
Create a Mission |
hgk mission create <name> |
Generate a Mission |
hgk mission generate <name> Generates Deployment code for all Deployment Instances within the Mission. |
Generate documentation for a Mission in the current Workspace. |
hgk mission generate-docs <name> |
10. Boards
| Task | Command |
|---|---|
Create a board |
hgk board create <name> |
Generate documentation for a Board in the current Workspace. |
hgk board generate-docs <name> |
11. OSALs (Operating System Abstraction Layers)
| Task | Command |
|---|---|
Build an OSAL and run its tests |
hgk osal build <name> |
Create an OSAL |
hgk osal create <name> |
Generate an OSAL |
hgk osal generate <name> Note: This command currently only generates the build system files associated with an OSAL, implementations of Periodic and Sporadic tasks are currently the full responsibility of the developer. |
Generate documentation for an OSAL in the current Workspace. |
hgk osal generate-docs <name> |