Isaac OS CLI
Look up ./isaac_os commands, modes, build options and argument forwarding.
The wrapper configures the Holoscan CLI
for this repository’s Docker, CMake, Ninja, CPM, sccache
and CTest workflow.
Alternatives to the CLI and containers
- Use CMake and Docker directly.
--dryrunshows the commands the CLI would use. - Build without containers if you provide the required toolchain and dependencies;
--localselects this path for CLI build, run and test commands. - Use another build system if it supplies the equivalent dependencies, generated files and compiler/linker settings.
Requirements
Run ./isaac_os from the repository root. The default container workflow requires
an accessible Docker daemon with the nvidia runtime and network access for CLI,
image and dependency downloads. --local uses your provisioned host toolchain and
dependencies instead of Docker.
The wrapper uses uv run to launch holoscan-cli from the environment locked in
uv.lock; the package pin lives in pyproject.toml. Without uv, it accepts a
pre-installed holoscan-cli only if its version or Git commit matches that pin.
See Prerequisites for installation and checks, and Supported platforms for platform support and application constraints.
Commands
Use ./isaac_os --help and ./isaac_os <command> --help for the complete,
version-specific lookup. Other exposed commands include create, install,
lint, package and setup; their generic availability does not establish
a validated Isaac OS external packaging workflow.
See the upstream CLI reference for the full command contract of the pinned Holoscan CLI 5.0.0.
Applications and mode names
The CLI discovers applications through their metadata.json files. Use the
metadata’s name, which need not match the directory name. Some CLI commands
also support non-executable projects, such as operators or libraries, if they
provide metadata. Directories without metadata are not discoverable standalone
projects; they can still be built as dependencies of a discovered application.
Modes are named presets for building or running a project. They are
application-specific and defined in its metadata. Use sim for Isaac Sim
and unitree_sim for Unitree MuJoCo.
See mode semantics and each application reference page for prerequisites and expected outcomes.
For a component without project metadata, configure an application that enables
it with ./isaac_os build <app_name> <mode> before building its CMake target in
that application’s build directory. To run tests, use test directly:
Argument boundaries
These examples show CMake options, mode lookup and application argument forwarding:
Tips:
- CLI options precede
--; executable arguments follow it. Use either--run-argsor trailing--for executable arguments; the wrapper rejects using both. - Repeat
--configure-argsfor separate CMake definitions. run --no-local-buildskips the application build;--no-docker-buildskips the image build. These require existing, up-to-date artifacts.run --nsys-args='<options>'enables Nsight Systems profiling and replaces its default profiler options. Keep it before--, separate from application arguments. See Profile an Application for NVTX capture settings.--dryrunprints commands without executing them.
Wrapper defaults
The image default is isaac_os_build:latest; the repository is mounted at
/workspace/isaac_os. The wrapper defaults to Holoscan SDK 5.0.0.
ISAAC_OS_EXTRA_DOCKER_BUILD_ARGS and
ISAAC_OS_EXTRA_DOCKER_RUN_ARGS extend the wrapper’s arguments.
Application metadata controls executable and working directory.