> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hypr.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# HYPR Documentation

HYPR is a microVM orchestration platform that runs OCI container images as lightweight virtual machines.

## What is HYPR?

HYPR bridges the gap between containers and virtual machines. It takes standard container images from any OCI registry and boots them as isolated microVMs with their own Linux kernel. This provides hardware-level isolation while maintaining the developer experience of containers.

Each VM runs:

* A minimal Linux kernel (6.12) with essential drivers
* A guest agent (Kestrel) as PID 1
* The container rootfs as a read-only squashfs with overlayfs for writes

## Why HYPR?

**VM-Level Isolation**: Each workload runs in its own virtual machine with separate kernel, memory, and CPU allocation. Kernel vulnerabilities in one VM cannot affect others.

**Container Ergonomics**: Use the same images, Dockerfiles, and compose files you already have. No new formats to learn.

**Networking**: Create isolated networks with custom CIDR ranges. Services in the same network can communicate by name.

**Volumes**: Persistent named volumes and bind mounts work the same as Docker.

**GPU Support**: Pass GPUs through to VMs for ML/AI workloads. Supports NVIDIA/AMD via VFIO on Linux and Metal on Apple Silicon.

**Fast Boot Times**: Optimized kernel and guest agent enable sub-second VM boot times.

## Documentation Sections

### Getting Started

* [Getting Started](getting-started.md) - Installation and first VM

### Core Concepts

* [CLI Reference](cli-reference.md) - Complete command documentation
* [Building Images](building-images.md) - Dockerfile support
* [Compose Stacks](compose.md) - Multi-service deployments

### Infrastructure

* [Networking](networking.md) - Network configuration and DNS
* [Volumes](volumes.md) - Persistent storage management

### Advanced

* [GPU Passthrough](gpu.md) - GPU acceleration
* [Architecture](architecture.md) - System internals
* [Configuration](configuration.md) - Environment and paths

### Operations

* [Troubleshooting](troubleshooting.md) - Common issues and solutions

## Platform Support

| Platform | Architecture  | Hypervisor       | GPU Support |
| -------- | ------------- | ---------------- | ----------- |
| Linux    | x86\_64       | cloud-hypervisor | VFIO        |
| Linux    | ARM64         | cloud-hypervisor | VFIO        |
| macOS    | Apple Silicon | libkrun          | Metal       |
| macOS    | Intel         | libkrun          | None        |

## Quick Example

```sh theme={null}
# Install HYPR
curl -fsSL https://get.hypr.tech | sh

# Run nginx with port mapping
hypr run nginx -p 8080:80

# Check running VMs
hypr ps

# View logs
hypr logs <vm-id> -f

# Execute command in VM
hypr exec <vm-id> -- cat /etc/nginx/nginx.conf

# Stop and remove
hypr stop <vm-id>
hypr rm <vm-id>
```

## Multi-Service Example

```yaml theme={null}
# docker-compose.yml
services:
  web:
    image: nginx:latest
    ports:
      - "8080:80"
    volumes:
      - ./html:/usr/share/nginx/html
    networks:
      - frontend

  api:
    image: myapi:latest
    networks:
      - frontend
      - backend
    depends_on:
      - db

  db:
    image: postgres:16
    environment:
      POSTGRES_PASSWORD: secret
    volumes:
      - pgdata:/var/lib/postgresql/data
    networks:
      - backend

volumes:
  pgdata:

networks:
  frontend:
  backend:
```

```sh theme={null}
# Deploy the stack
hypr compose up -d

# Check status
hypr compose ps

# Tear down
hypr compose down mystack
```

## License

HYPR is licensed under the Business Source License 1.1 (BSL-1.1).