Skip to content

Installation

HeadlessOS can run in three ways, depending on your preference.

Section titled “Option 1 — From source (recommended for now)”

Best for development and trying out the latest features.

Terminal window
git clone https://github.com/abhee235/headlessos.git
cd headlessos
npm install
npm run dev

See the Quick Start for details.

A standalone macOS app wrapper is included in the repo at electron/. Build it yourself:

Terminal window
cd electron
npm install
npm run build

The packaged app starts both the backend and the UI bundled together — no terminal needed.

A pre-built Docker image is on the roadmap. Subscribe to the GitHub repo for release notifications.

MinimumRecommended
OSmacOS 12 / Linux / Windows 10+latest
Node.js20.x22.x LTS
RAM512 MB1 GB
Disk200 MB500 MB

Note: these are for your local machine only — the remote server has no requirements beyond a working sshd.