holoscan-cli 4.2.0

Command line interface for packaging and running Holoscan applications.

Holoscan CLI

Command line interface for packaging and running Holoscan applications.

Overview

This repository is the home for Holoscan CLI. It includes tools for packaging and running Holoscan applications.

Prerequisites

You will need a platform supported by NVIDIA Holoscan SDK. Refer to the Holoscan SDK User Guide for the latest requirements. In general, Holoscan-supported platforms include:

• An x64 PC with an Ubuntu operating system and an NVIDIA GPU or
• A supported NVIDIA ARM development kit.

Installation

Holoscan CLI is delivered as a Python package and can be installed from PyPI.org using one of the following commands:

Holoscan SDK Version	Installation Command	CUDA Version
2.8 or earlier	pip install holoscan	12.6
2.9 or later	pip install holoscan-cli	12.6

Build From Source

Prerequisites

To build the Holoscan CLI from source, you will need to clone this repository and install the following dependencies:

• Python 3.10+.
• poetry 2.0+

Development Environment

Holoscan CLI uses Poetry for package and dependency management. After installing Poetry, run the following commands to get started:

# Create virtual environment
poetry env use python3.12

# Activate virtual environment
eval $(poetry env activate)

# Install dependencies
poetry install

# Configure pre-commit hooks
pre-commit install

# Run pre-commit against all files
pre-commit run --all-files

# Build sdist package
poetry build

# Run tests
poetry run pytest

For more information on Poetry and its usages, see the Poetry documentation.

Contributing to the Holoscan CLI

See CONTRIBUTING.md for details.