Getting started

The installation and quick start below are shared with the project README. Read that source when browsing Markdown without the site renderer.

Install

Requires Node.js >=22.18.0.

pnpm add -D @xova/matrix

Minimal Linux images also need the system ps command. See process shutdown for platform requirements.

Quick start

Create matrix.config.ts in the workspace root:

import { defineMatrixConfig } from '@xova/matrix'

export default defineMatrixConfig({
  projects: {
    web: {
      root: './apps/web',
      targets: {
        dev: 'vite',
        build: { command: 'vite build', artifacts: { mode: 'archive' } },
        preview: 'vite preview',
      },
    },
  },
  products: {
    app: {
      version: '1.0.0',
      variants: { web: 'web' },
    },
  },
})

Run it from the directory containing the config file:

pnpm exec matrix dev app
pnpm exec matrix build app --env staging
pnpm exec matrix plan app --target preview --env production
pnpm exec matrix doctor

This assumes the Web project already has Vite installed and builds independently. An explicit product version avoids relying on the project's package version for archives; archive retains Web output for preview. dev is continuous: stop it with Ctrl+C before running another command. Run pnpm exec matrix for the interactive wizard; complete commands execute directly.

Continue with configuration, or try the framework-free example.