[](https://github.com/nvidia-holoscan/holoscan-cli/actions/workflows/check.yaml)
[](https://coveralls.io/github/nvidia-holoscan/holoscan-cli)
# 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](https://docs.nvidia.com/holoscan/sdk-user-guide/sdk_installation.html#prerequisites). 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 |
| -------------------- | -------------------------- |
| 2.8 or earlier | `pip install holoscan` |
| 2.9 or later | `pip install holoscan-cli` |
## 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+](https://python-poetry.org/docs/#installation)
### Development Environment
Holoscan CLI uses [Poetry](https://python-poetry.org/) for package and dependency management. After installing Poetry, run the following commands to get started:
```bash
# 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](https://python-poetry.org/docs/).
## Contributing to the Holoscan CLI
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "holoscan-cli",
"maintainer": "mocsharp",
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": null,
"keywords": "AI, holoscan, medical, streaming, HPC, nvidia, docker, container",
"author": "NVIDIA",
"author_email": null,
"download_url": null,
"platform": null,
"description": "[](https://github.com/nvidia-holoscan/holoscan-cli/actions/workflows/check.yaml)\n[](https://coveralls.io/github/nvidia-holoscan/holoscan-cli)\n\n# Holoscan CLI\n\nCommand line interface for packaging and running Holoscan applications.\n\n## Overview\n\nThis repository is the home for Holoscan CLI. It includes tools for packaging and running Holoscan applications.\n\n## Prerequisites\n\nYou will need a platform supported by [NVIDIA Holoscan SDK](https://docs.nvidia.com/holoscan/sdk-user-guide/sdk_installation.html#prerequisites). Refer to the Holoscan SDK User Guide for the latest requirements. In general, Holoscan-supported platforms include:\n\n- An x64 PC with an Ubuntu operating system and an NVIDIA GPU or\n- A supported NVIDIA ARM development kit.\n\n## Installation\n\nHoloscan CLI is delivered as a Python package and can be installed from PyPI.org using one of the following commands:\n\n| Holoscan SDK Version | Installation Command |\n| -------------------- | -------------------------- |\n| 2.8 or earlier | `pip install holoscan` |\n| 2.9 or later | `pip install holoscan-cli` |\n\n## Build From Source\n\n### Prerequisites\n\nTo build the Holoscan CLI from source, you will need to clone this repository and install the following dependencies:\n\n- Python 3.10+.\n- [poetry 2.0+](https://python-poetry.org/docs/#installation)\n\n### Development Environment\n\nHoloscan CLI uses [Poetry](https://python-poetry.org/) for package and dependency management. After installing Poetry, run the following commands to get started:\n\n```bash\n# Create virtual environment\npoetry env use python3.12\n\n# Activate virtual environment\neval $(poetry env activate)\n\n# Install dependencies\npoetry install\n\n# Configure pre-commit hooks\npre-commit install\n\n# Run pre-commit against all files\npre-commit run --all-files\n\n# Build sdist package\npoetry build\n\n# Run tests\npoetry run pytest\n```\n\nFor more information on Poetry and its usages, see the [Poetry documentation](https://python-poetry.org/docs/).\n\n## Contributing to the Holoscan CLI\n\nSee [CONTRIBUTING.md](./CONTRIBUTING.md) for details.\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Command line interface for packaging and running Holoscan applications.",
"version": "3.5.0",
"project_urls": {
"Documentation": "https://docs.nvidia.com/holoscan/sdk-user-guide/index.html",
"Homepage": "https://github.com/nvidia-holoscan/holoscan-cli",
"Repository": "https://github.com/nvidia-holoscan/holoscan-cli"
},
"split_keywords": [
"ai",
" holoscan",
" medical",
" streaming",
" hpc",
" nvidia",
" docker",
" container"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d05dff647d5ddf89971a1a0bb1ebc5e53b1e320096fa93ff71a1810542f0732",
"md5": "0f1ca2b5a6311e2cbbab7f4ed0f306a2",
"sha256": "4985c9e1b1911cc907eda21f63e007e2d2649d120b4451430f420c781d5475d4"
},
"downloads": -1,
"filename": "holoscan_cli-3.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f1ca2b5a6311e2cbbab7f4ed0f306a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 73388,
"upload_time": "2025-08-04T18:39:47",
"upload_time_iso_8601": "2025-08-04T18:39:47.702660Z",
"url": "https://files.pythonhosted.org/packages/3d/05/dff647d5ddf89971a1a0bb1ebc5e53b1e320096fa93ff71a1810542f0732/holoscan_cli-3.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-04 18:39:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nvidia-holoscan",
"github_project": "holoscan-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "holoscan-cli"
}
JSON
