Getting started

What this is for. You are installing the EYAS server so the web UI exists on your machine. This page is the install path, not a product tour.

When you are done, go to the Setup wizard, then Your first hour.

What you will do

Install EYAS (native or Docker)
Start the server
Complete the setup wizard
Open the web UI and begin work — next: Your first hour

Prerequisites

Requirement	Notes
Bun 1.x (recommended) or Node.js 22+	Primary runtime is Bun
Disk space	SQLite DB, vault and agent files under `data/`; conversation workspaces (see below)
Optional: Docker / Compose	Container deploy
Optional: host CLIs	`claude`, `grok`, or `kimi` if you want keyless local providers

Native install

git clone https://github.com/eyssen/eyas.git
cd eyas
bun install
./bin/eyas start

Open http://localhost:3100 (default port from config/default.yaml — 3100, not 3000).

Foreground (logs in the terminal):

./bin/eyas serve

One-line installer

curl -fsSL https://raw.githubusercontent.com/eyssen/eyas/main/scripts/install.sh | bash

Non-interactive: append bash -s -- --yes. Pin a release: --version 0.8.16-beta.

Windows: scripts/install.ps1.

Docker

git clone https://github.com/eyssen/eyas.git
cd eyas
docker compose up -d

Open http://localhost:3100. Optional GPU + Ollama:

docker compose --profile gpu up -d

Lifecycle commands

Command	What it does
`eyas serve`	HTTP server in the foreground
`eyas start`	Background server (pidfile + log file)
`eyas stop`	Stop background process
`eyas restart`	Stop then start
`eyas status`	Health + PID
`eyas doctor`	Local environment diagnostics
`eyas version`	Version string

On start, EYAS auto-builds the frontend and product docs if missing or stale (bun run build:web, bun run docs:build), unless you set EYAS_SKIP_WEB_BUILD=1 / EYAS_SKIP_DOCS_BUILD=1.

Step	Result
Browser → `/setup` (automatic if setup incomplete)	Setup wizard
After setup	Login with the root owner account you created
Home	Home
Product docs	Always at `/docs/` on the same host/port

Where data lives

Under the instance home (EYAS_HOME or the directory you started from). The data directory is data/ there unless EYAS_DATA_DIR names another folder — everything below data/ then lives in that folder:

Path	Contents
`data/sqlite/`	Main SQLite database (WAL mode, `synchronous = NORMAL`)
`data/vault/`	Semantic / procedural markdown vault — always `<data dir>/vault`
`data/agents/<id>/`	Per-agent workspace files (IDENTITY, SOUL, …)
`data/backups/`	Backup archives
`config/`	YAML defaults + local overlays

Conversation workspaces — the folder each conversation without folders of its own works in — are in data/workspaces/ on Docker, Kubernetes and packaged installs. A source install run from a git clone keeps them outside the checkout, in your user’s application-data directory. See Configuration — Conversation workspaces.