system README

The project's README from github.com/PhreshOS/system. As one markdown file: README.md.

PhreshOS

PhreshOS

An open-source, self-hosted system for apps built with web technologies.

Website · Documentation · Live demo · Releases

The PhreshOS Desktop: Terminal showing phresh fetch, Files, and the Map with windows beyond the view

PhreshOS runs on the machine you install it on, keeps your Programs running there, and gives you a Desktop in the browser to use them from. Programs are built with the web tools you already know. The System gives each of them a place to run, one sign-in, communication with other Programs, storage, and permissions, so a Program only holds its own logic.

Everything on the Desktop, from the file manager to Settings and the wallpaper, is a Program built on the System, not part of it.

This repository is the System: the service that runs on your machine, and the Desktop it serves.

What Programs get

Try it

The live demo gives you a disposable Desktop for an hour, with nothing to install.

To install PhreshOS on macOS or Linux, you need Node.js 24.15 or newer:

[!NOTE] Windows is not fully supported yet. The System installs and runs there, but some Programs do not work.

npm install --global @phreshos/cli
phresh system install

The command installs the System as a service of your user, starts it, and prints the Desktop's address, usually http://localhost:4300. The first visit creates the owner account. See Installation to update, stop, or remove it, or to change where it keeps its data.

Then create your first Program:

phresh create my-program
cd my-program
phresh dev

What the System does

The System owns the running state of PhreshOS:

The browser shows this state; it does not hold it. A Desktop, a Node script, and the phresh command all reach the same System, through contracts defined in @phreshos/core. See The System for the full model.

Terminal, Files, and Settings on the PhreshOS Desktop

Development

You need Bun 1.3 and Node.js 24.15 or newer.

bun install --frozen-lockfile
bun run dev

dev runs the System from source, with its data in storage/ in this repository and the Desktop on the first free port from 5300. An installed System uses ~/.phreshos and ports from 4300, so both can run side by side. PHRESHOS_HOME and PHRESHOS_PORT choose another home or port.

Command Does
bun run check Type-checks the source
bun run build Builds the server and the Desktop into dist/
bun run test Runs the tests in tests/
bun run verify Runs check, build, and test, including a test that packs the release, installs it in a temporary folder, and boots it
bun run pack Builds the release archive and its checksum

The source has three parts: source/server is the System, source/client is the Desktop, and source/shared holds what both use.

Repository Role
core The contracts shared by every part of PhreshOS
client The SDK for a Program's Client Endpoint, in its Window
server The SDK for a Program's Server Endpoint
node The SDK for Node.js code that reaches a running System
react React bindings for the SDKs
react-ui The component library the Desktop and Programs draw with
cli The phresh command: installs the System, builds Programs, and reaches the running System
website phreshos.com and its documentation

Contributing

See CONTRIBUTING.md. To report a vulnerability privately, see SECURITY.md.

License

MIT. Copyright © 2026 Zohayr SLILEH.

system (PhreshOS/system)

Searching Database…

282 ·GitHub
System
Что это?PhreshOS — открытая self-hosted система, работающая на подконтрольной вам машине и подающая браузерный Desktop для использования приложений («Programs»), построенных на веб-технологиях.
Это приложение или скорее платформа наподобие операционной системы?Это полноценная система, а не просто библиотека: фоновый сервис (System), который управляет Programs, разрешениями, хранилищем и входом, плюс UI Desktop, подаваемый через браузер. Сами Programs строятся отдельно с использованием предоставляемых SDK.
Как запустить PhreshOS?С Node.js 24.15+ на macOS или Linux одна команда установки настраивает System как пользовательский сервис, запускает его и выводит адрес Desktop; при первом визите создаётся аккаунт владельца. Можно также попробовать живое демо — оно даёт одноразовый Desktop на час без какой-либо установки.
Что нужно установить для запуска?Для установки и запуска System требуется Node.js 24.15 или новее. Для сборки из исходников или разработки Programs также нужен Bun 1.3.
Полностью ли он работает на Windows?Пока нет — сам System устанавливается и работает на Windows, но некоторые Programs там работают некорректно.
Мои данные остаются на моей собственной машине?Да — PhreshOS self-hosted, поэтому System и данные ваших Programs работают на машине, куда вы его установили, а не на стороннем сервере.
Что именно такое «Program» в PhreshOS?Program — это приложение, построенное на System со своими Server и Client Endpoints; System предоставляет ему место для выполнения, вход, хранилище, коммуникацию и разрешения, так что Program остаётся только нести собственную логику.
Может ли AI-агент пользоваться теми же приложениями, что и я?Да — AI-агент может пользоваться теми же Programs через командную строку phresh и SDK, пока человек пользуется ими с Desktop.
Содержит ли этот репозиторий всё, включая SDK и CLI?Нет — в этом репозитории только System и Desktop. SDK (core, client, server, node), React-биндинги, библиотека компонентов, phresh CLI и сайт живут в отдельных связанных репозиториях.
Как мне построить собственную Program для PhreshOS?Вы используете уже знакомые веб-инструменты (JS/веб-фронтенд плюс сервер) вместе с SDK Server/Client/Node и phresh CLI, который собирает Programs и общается с работающим System.
What are similar projects?puter, PiG, executor, claude-code, daedalOS, wigolo, oh-my-pi, Airsec
Which topics is it in?desktop-environment, bun, sdk, ai-agent, command-line-tool, framework, agent, tool, server, nodejs, typescript, self-hosted
Creator
PhreshOS
Size
34.9 MB
Stars
282
Updated
CommitOct 15Releasev0.8.6Oct 15
Age
1mo
Commits · 90 Days