@phreshos/core

The environment-neutral contracts and domain objects shared across PhreshOS.

Documentation · Runtime model · Source

Role

Core is the single source of truth for the System, Program, Process, Endpoint, Service, Context, Desktop, Window, communication, storage, Appearance, permission, and Execute contracts. It also provides the runtime classes whose references are preserved by the environment SDKs.

Core contains no transport, persistence, command-line, or visual implementation. Those implementations consume its contracts without redefining them.

Installation

| Package manager | Command | | --- | --- | | npm | npm install @phreshos/core | | pnpm | pnpm add @phreshos/core | | Bun | bun add @phreshos/core | | Yarn | yarn add @phreshos/core |

import {
  ClientEndpoint,
  defineConfig,
  Process,
  Program,
  ServerEndpoint,
} from "@phreshos/core"

See Program configuration for the configuration contract and Runtime for the shared domain model.

Development

bun install --frozen-lockfile
bun run verify

check performs static checks. build creates the package. test runs the Vitest suite, including completion and built-package consumer tests, so build first when running tests separately. verify runs all three in that order.

Assertions and their fixtures live in tests/; operational tooling belongs in scripts/. Verification uses the committed dependency graph without local package substitutions.

Related repositories

• @phreshos/client, @phreshos/server, and @phreshos/node implement the shared contracts at their respective boundaries.
• @phreshos/react adapts live Core contracts to React.
• PhreshOS System owns the authoritative runtime implementation.
• PhreshOS Documentation owns the canonical public explanation of these contracts.

Contributing

See CONTRIBUTING.md for the repository workflow and SECURITY.md for private vulnerability reporting.

License

Licensed under the MIT License. Copyright © 2026 Zohayr SLILEH.