Skip to content

Packages Overview

Packages are organized by responsibility.

libs/ core packages

These packages define the manifest contract, compile manifests, and render applications.

PackageRole
@ikary/cell-contractZod schemas, TypeScript types, structural and semantic validation
@ikary/cell-loaderYAML and JSON parsing, meta-property stripping, validation pipeline
@ikary/cell-engineCompilation, normalization, field derivation, path builders
@ikary/cell-presentationZod schemas for UI primitive contracts
@ikary/cell-primitivesReact primitive components, resolvers, adapters, registry
@ikary/cell-dataData providers and entity data hooks
@ikary/cell-rendererTop-level CellAppRenderer and page rendering runtime

See Loading & Validation for the full contract pipeline API.

apps/ executable packages

These packages run as applications or CLIs.

PackageRole
@ikary/cliikary CLI for scaffolding, validation, compilation, local stack commands, and primitives tooling
@ikary/ikaryThin npm wrapper that exposes the same ikary command
@ikary/cell-runtime-apiLocal runtime REST API service generated from manifests
@ikary/cell-preview-serverLocal preview server used by the local stack
@ikary/mcp-serverContract Intelligence API and MCP server

Dependency graph

graph TD
    contract[contract] --> loader[loader]
    contract --> engine[engine]
    contract --> presentation[presentation]
    contract --> primitives[primitives]
    presentation --> primitives
    primitives --> renderer[renderer]
    primitives --> data[data]
    engine --> renderer

Processing pipeline

flowchart TD
    A[YAML file] -->|load| B[loader]
    B -->|parse| C[contract]
    C -->|validate| D[engine]
    D -->|compile| E[Runtime CellManifestV1]
typescript
import { loadManifestFromFile } from '@ikary/cell-loader';
import { compileCellApp } from '@ikary/cell-engine';

const loaded = await loadManifestFromFile('manifest.yaml');
if (loaded.valid) {
  const compiled = compileCellApp(loaded.manifest!);
}

Build commands

bash
pnpm build
pnpm test
pnpm typecheck