@phreshos/client

The runtime adapter for a PhreshOS Program's Client Endpoint.

Documentation · Client Context · Desktop · Source

Role

The Client SDK exposes three separate Core contracts inside a Client Endpoint: the global system, the current Client context, and the containing desktop. It adapts the Desktop boundary without defining client-specific versions of the shared Program, Process, Endpoint, or Service domains.

The System enforces Client authority. The SDK carries requests and preserves canonical handles; it does not own authoritative state or visual components.

Installation

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

@phreshos/core is a peer dependency.

import { context, desktop, system } from "@phreshos/client"

const program = await context.program()
const preferences = await desktop.preferences.snapshot()
const appearance = await system.appearance.snapshot()

See Client SDK for the complete entry points and authority boundary.

Development

bun install --frozen-lockfile
bun run verify

verify checks the types and completions, builds the package, and validates its published shape.

check performs static checks, build creates distributable output, and test runs Vitest assertions from tests/. Run build before testing built artifacts. verify runs check, build, and test in order. Operational tooling belongs in scripts/; tests and their fixtures belong in tests/. Verification uses the committed dependency graph without local package substitutions.

Related repositories

• @phreshos/core is the one public import path for every shared contract and domain class implemented by these handles.
• @phreshos/server adapts the paired Server Endpoint boundary.
• @phreshos/react adapts the Client sources to React without depending on this package.
• PhreshOS System owns enforcement, routing, and the Desktop host.

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.