# nvidia-omniverse/kit-app-template architecture

> Architecture diagram of the GitHub repository nvidia-omniverse/kit-app-template, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nvidia-omniverse/kit-app-template
- Repository: https://github.com/nvidia-omniverse/kit-app-template

## Overview

##### Project Type & Purpose
- Type: An open-source scaffolding toolset, providing CLI wrappers, templates, and tooling for generating, building, testing, launching, and packaging Omniverse Kit applications and extensions.
- Purpose: Accelerate GPU-accelerated 3D application development by exposing a suite of templates (apps & extensions), scripts (repo.sh, repo.bat), and tools (packman, repoman, premake) to automate common workflows.

##### File Structure & Readme Insights
Top-Level Components
– CLI Entry-Points: repo.sh (Linux), repo.bat (Windows)
– Build Config: premake5.lua
– Templates: /templates/apps/* and /templates/extensions/*
– Tools: /tools (containers, deps, packman, repoman)
– Docs & Assets: /readme-assets, README.md
Key Patterns
– Template-Engine pattern: static folder of “blueprints” used by CLI
– Plugin-style extensibility: each template defines a “.kit” file, extension.toml, code stubs
– Toolchain orchestration: shell+Python wrappers invoking packman/repoman and premake to manage deps and compile

A. Developer Environment
- CLI Scripts (repo.sh, repo.bat)
- Configuration (repo.toml, repo_tools.toml)
- VSCode / IDE settings
B. Template Repository
- Applications templates (kit_base_editor, kit_service, usd_composer, etc.)
- Extension templates (basic_python, basic_cpp, python_ui, etc.)
C. Tooling Engine
- Repoman: orchestrates high-level repo commands (template new, build, test, launch, package)
- Packman: dependency manager for Omniverse Kit SDK and other libs
- Premake5: generates platform-specific build files (Makefiles, MSVC projects)
D. Container & Deployment
- Dockerfile.j2 and entrypoint scripts (tools/containers)
- NVIDIA Container Toolkit integration
E. External Services
- Omniverse Kit SDK (NGC registry)
- Cloud Streaming platforms (OVC, GDN)

##### Component Relationships & Data Flows
- Developer invokes CLI → CLI parses repo.toml & invokes Repoman
- Repoman → Template Engine reads /templates/*, populates new project under /source/apps or /source/extensions
- Build Step → Repoman calls Packman to resolve dependencies → invokes Premake to generate build files → native compiler toolchain (MSVC or GCC)
- Test Step → Runs unit tests via generated test runners
- Launch Step → Loads compiled .kit application against Omniverse Kit SDK libraries
- Package Step → Uses Packman to bundle app/extension, optionally Dockerizes via containers scripts
- Container Build → Dockerfile.j2 templated by Packman outputs GPU-enabled container

##### Architectural Patterns & Principles
- Modular / Plugin architecture: templates represent self-contained modules that can be assembled
- Separation of concerns: distinct layers for template generation, dependency management, build orchestration, packaging
- Convention over configuration: standardized file naming (.kit, extension.toml) and directory layout

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Developer Machine
    subgraph "Developer Machine"
        direction TB
        CLI_Scripts["repo.sh / repo.bat"]:::cli
        Config_Files["repo.toml / repo_tools.toml"]:::cli
        IDE[".vscode/"]:::cli
    end

    %% Repository Layer
    subgraph "Template Repository"
        direction TB
        Templates_Apps["templates/apps/"]:::templates
        Templates_Ext["templates/extensions/"]:::templates
        Docs["README.md / readme-assets/"]:::external
    end

    %% Tooling Engine Layer
    subgraph "Tooling Engine & Build"
        direction TB
        Repoman["Repoman (tools/repoman/)"]:::cli
        Packman["Packman (tools/packman/)"]:::tooling
        Premake["premake5.lua"]:::tooling
        Deps["tools/deps/"]:::tooling
        Package_Scripts["tools/package.sh / tools/package.bat"]:::tooling
        Containers["tools/containers/Dockerfile.j2 / entrypoint*.j2"]:::tooling
    end

    %% External Services
    subgraph "External Services"
        direction TB
        SDK["Omniverse Kit SDK (NGC Registry)"]:::external
        Cloud["Cloud Streaming (OVC, GDN)"]:::external
    end

    %% Flows
    CLI_Scripts -->|"reads"| Config_Files
    CLI_Scripts -->|"invokes"| Repoman
    Repoman -->|"uses templates"| Templates_Apps
    Repoman -->|"uses templates"| Templates_Ext
    Repoman -->|"resolves deps"| Packman
    Packman -->|"manages SDK deps"| SDK
    Packman -->|"provides deps to"| Premake
    Premake -->|"generates build files"| Deps
    Premake -->|"calls compiler"| Compiler["Native Compiler (MSVC/GCC)"]:::external
    Compiler -->|"outputs binaries"| LaunchStep["Launch .kit App"]:::external
    LaunchStep --> SDK
    Repoman -->|"runs tests"| TestRunner["Test Runner"]:::tooling
    TestRunner -->|"executes on"| Compiler
    Repoman -->|"packages with"| Package_Scripts
    Package_Scripts -->|"bundles binaries"| PackageOutput["App/Extension Package"]:::tooling
    Package_Scripts -->|"triggers container build"| Containers
    Containers -->|"requires NVIDIA Toolkit"| SDK
    Containers -->|"deploys to"| Cloud

    %% Click Events
    click CLI_Scripts "https://github.com/nvidia-omniverse/kit-app-template/blob/main/repo.sh"
    click CLI_Scripts "https://github.com/nvidia-omniverse/kit-app-template/blob/main/repo.bat"
    click Config_Files "https://github.com/nvidia-omniverse/kit-app-template/blob/main/repo.toml"
    click Config_Files "https://github.com/nvidia-omniverse/kit-app-template/blob/main/repo_tools.toml"
    click IDE "https://github.com/nvidia-omniverse/kit-app-template/tree/main/.vscode/"
    click Templates_Apps "https://github.com/nvidia-omniverse/kit-app-template/tree/main/templates/apps/"
    click Templates_Ext "https://github.com/nvidia-omniverse/kit-app-template/tree/main/templates/extensions/"
    click Docs "https://github.com/nvidia-omniverse/kit-app-template/blob/main/README.md"
    click Docs "https://github.com/nvidia-omniverse/kit-app-template/tree/main/readme-assets/"
    click Repoman "https://github.com/nvidia-omniverse/kit-app-template/blob/main/tools/repoman/repoman.py"
    click Packman "https://github.com/nvidia-omniverse/kit-app-template/tree/main/tools/packman/"
    click Premake "https://github.com/nvidia-omniverse/kit-app-template/blob/main/premake5.lua"
    click Deps "https://github.com/nvidia-omniverse/kit-app-template/tree/main/tools/deps/"
    click Package_Scripts "https://github.com/nvidia-omniverse/kit-app-template/blob/main/tools/package.sh"
    click Package_Scripts "https://github.com/nvidia-omniverse/kit-app-template/blob/main/tools/package.bat"
    click Containers "https://github.com/nvidia-omniverse/kit-app-template/blob/main/tools/containers/Dockerfile.j2"
    click Containers "https://github.com/nvidia-omniverse/kit-app-template/blob/main/tools/containers/entrypoint.j2"

    %% Styling
    classDef cli fill:#D0E6FF,stroke:#0041C2
    classDef templates fill:#D8F5D8,stroke:#006400
    classDef tooling fill:#FFE5B4,stroke:#FF8C00
    classDef external fill:#F0F0F0,stroke:#808080
```
