main

heliaAOT CLI API

The cli module provides a command line interface (CLI) for the heliaAOT library. The CLI allows users to convert a model into a highly optimized, ahead-of-time (AOT) module for Ambiq's ultra-low-power SoCs. Both command line arguments and YAML configuration file can be suppled, in which case the command line arguments will override the YAML configuration.

Copyright 2025 Ambiq. All Rights Reserved.

Classes

Functions

version

version()

Display the version of the heliaAOT library.

render_target_list

render_target_list() -> str

Render the full supported-target listing printed by list-targets.

Returns:

• str ( str ) –

  Plain-text summary table followed by a discovery hint.

render_target_info

render_target_info(name: str) -> str

Render the detail view printed by target-info.

Parameters:

• name

  (str) –

  Target platform name, as reported by list-targets.

Returns:

• str ( str ) –

  Multi-line description of the target.

Raises:

• ConfigValueError –

  If name is not a registered target (also a ValueError). The message lists every valid target name.

list_targets

list_targets()

List every supported target platform name with a short summary.

The printed TARGET values are the strings accepted by --platform.name (CLI) and platform.name (YAML).

target_info

target_info(name: Annotated[str, Option(help='Target platform name, as reported by `list-targets`.')])

Show the full capability and memory profile of a single target.

Parameters:

• name

  (str) –

  Target platform name, as reported by list-targets.

Raises:

• Exit –

  With code 1 if name is not a registered target; the rendered error lists every valid target name.

run

run()

Main function to run the CLI.