Installation & CLI Reference

Docker (Recommended for Deployment)

The fastest way to deploy tvh-guide-ng is with Docker Compose:

cd docker
cp .env.example .env
# Edit .env — set TVH_URL to your TVHeadend instance
docker compose up -d

See docker/README.md for full configuration options, networking guides, and troubleshooting.

From Source

Prerequisites

Volta (Node.js version manager)

Volta pins exact Node.js and pnpm versions per project, so every contributor uses the same toolchain.

# Install Volta
curl https://get.volta.sh | bash

# Volta reads the "volta" key in package.json and installs automatically:
#   Node.js 22.14.0
#   pnpm 10.4.1
volta install node pnpm

Setup

# Clone the repo
git clone <repo-url> && cd tvh-guide-ng

# Install all workspace dependencies
pnpm install

Workspace Commands

Running scripts across packages

# Run dev in all packages (parallel)
pnpm dev

# Build all packages
pnpm build

# Lint all packages
pnpm lint

# Clean all build artifacts
pnpm clean

Targeting a specific package

# Run a script in a single package
pnpm --filter @tvh-guide/web dev
pnpm --filter @tvh-guide/epg-service build

# Add a dependency to a specific package
pnpm --filter @tvh-guide/web add svelte

# Add a shared workspace dependency
pnpm --filter @tvh-guide/web add @tvh-guide/shared --workspace

Recursive operations

# Run a script in every package that defines it
pnpm -r test

# List all workspace packages
pnpm -r ls --depth -1