← HELLO OS

Get started with HELLO OS

HELLO OS is a local-first agentic OS prototype. The Docker Compose deployment starts the Next.js dashboard and separate MCP service together. GitHub Pages hosts this guide only; it does not host the running app.

Requirements

Install Docker Engine and the Docker Compose plugin on Linux, Docker Desktop on macOS or Windows, then confirm docker compose version works.

Start with Docker Compose

git clone https://github.com/CodesbyFebin/Hello-OS.git
cd Hello-OS
docker compose up --build

Open http://localhost:3000 for the dashboard. MCP is at http://localhost:3030/mcp. The SQLite database persists in the named hello-data volume.

Install scripts

Run from source

For development, install Node.js 20 or newer, npm, and Bun for MCP. From the repository root run:

npm install
cp .env.example .env
npx prisma generate
npx prisma db push
npm run dev

Run npm run mcp in another terminal to start the MCP service. Use npm run build and npm start for a production build.

Configuration and data

See .env.example for DATABASE_URL, HELLO_MCP_URL, HELLO_PUBLIC_URL, and allowed origins. Docker stores SQLite data in a named volume. Back up this volume and never delete it unless you intend to remove the workspace data.

Security notes

The current demo server stores generated private signing keys and is not a production key-management solution. The prototype is not a hardened public deployment. Before exposing it to the internet, add authentication, TLS, rate limits, secret management, monitoring, backups, and a security review. See prototype boundaries.

Stop the app

Press Ctrl+C or run docker compose down. That preserves data. docker compose down --volumes removes stored data and should be used only when you intentionally want to erase it.

See all platform options →