Skip to content

Reference#

Every hpx subcommand and flag, the full configuration schema, and the Python API. For learning the tool, the Getting Started and User Guide pages are usually a better starting point.

CLI#

  • hpx profile

    Build, flash, capture, report.

    profile

  • hpx doctor

    Verify toolchain and probe availability.

    doctor

  • hpx boards

    List supported boards.

    boards

  • hpx engines

    List supported engines.

    engines

  • hpx probes

List and match J-Link probes.

probes

  • hpx ports

List host serial ports.

ports

  • hpx target

Run target reset helpers.

target

  • hpx analyze

Static model analysis, no hardware.

analyze

  • hpx compare

Diff two profile result directories.

compare

  • hpx validate

Hardware-in-the-loop validation suite.

validate

  • hpx power-on

Hold Joulescope passthrough power on.

power-on

  • hpx cache

Inspect or purge local build caches.

cache

Configuration Reference#

Every ProfileConfig field, its YAML path, CLI flag, default, and type — see the Configuration Reference.

Python API#

Calling heliaPROFILER from Python instead of the shell? See the Python API reference for profile(), ProfileConfig, and the typed result and error types.

Common conventions#

  • Positional arg vs --config — hpx profile model.tflite is a shortcut for model.path. With a config file, omit the positional arg and use --config hpx.yml.
  • CLI overrides YAML — any flag passed on the command line wins over the matching field in the config file.
  • Verbose — -v adds INFO logs, -vv adds DEBUG. Useful for diagnosing build/flash/capture failures.
  • Help — every subcommand accepts -h / --help.