Prerequisites
Node.js 18+ and npm are required.
Install and Operate
Follow this quick guide to install dependencies, run the server, create and verify sessions, and launch the demo scripts for live dashboard data.
1) Install and Build
Node.js 18+ and npm are required.
npm install
npm run build
npm test
2) Start EctoClaw
npm run dev -- serve --dev
npm run build
npm start
Dashboard: http://localhost:3210/dashboard/
API: http://localhost:3210/api/
SSE: http://localhost:3210/api/stream
Health: http://localhost:3210/health
3) Create and Verify a Session
curl -X POST http://localhost:3210/api/sessions \
-H "Content-Type: application/json" \
-d '{"goal":"Audit first OpenClaw run"}'
curl -X POST http://localhost:3210/api/sessions/<SESSION_ID>/events \
-H "Content-Type: application/json" \
-d '{"type":"MessageReceived","channel":"discord","sender":"user","content":"hello"}'
curl http://localhost:3210/api/sessions/<SESSION_ID>/verify
curl -X POST http://localhost:3210/api/sessions/<SESSION_ID>/seal
4) Install and Run the Demo
Works on macOS, Linux, and Windows.
npx tsx scripts/demo.ts
# or
npm run demo
bash scripts/demo.sh
PORT=3210 KEEP_DB=1 npm run demo
KEEP_DB=1 preserves the temporary demo database after script exit.
5) Useful CLI Commands
npx ectoclaw serve --dev
npx ectoclaw sessions
npx ectoclaw status
npx ectoclaw verify <SESSION_ID>
npx ectoclaw report <SESSION_ID> --format html --output report.html