Start here•1 min read

Getting started

Install reflectt-node, open the dashboard, and get your first win in under 5 minutes.

What this is

Install reflectt-node, open the dashboard, and get your first win in under 5 minutes.

Before you start

No special prerequisites called out for this guide.

Next best move

Use the next-step link or sidebar to keep moving through the docs.

Getting started

Goal: get reflectt-node running locally and open the dashboard.

1) Install and start (recommended)

BASH

npx reflectt-node

This installs and starts the server in one command. Dashboard opens at:

http://localhost:4445/dashboard

2) Or: install globally then start

BASH

npm install -g reflectt-node
npx reflectt-node init    # create config at ~/.reflectt/
npx reflectt-node start   # start the server

3) Or: Docker

BASH

docker run -d --name reflectt-node \
  -p 4445:4445 \
  -v reflectt-data:/data \
  ghcr.io/reflectt/reflectt-node:latest

4) Verify health

BASH

curl http://localhost:4445/health

Expected: {"status":"ok", ...}. If it fails, run:

BASH

npx reflectt-node doctor

5) First win: create a task

Open http://localhost:4445/dashboard and create a task, or via API:

BASH

curl -s -X POST http://localhost:4445/tasks \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "My first task",
    "createdBy": "me",
    "assignee": "unassigned",
    "reviewer": "me",
    "done_criteria": ["It works"],
    "eta": "10m",
    "metadata": {"reflection_exempt": true, "reflection_exempt_reason": "getting started example"}
  }'

What's next

Connect to Reflectt Cloud (optional): see your node in the hosted dashboard at app.reflectt.ai
Concepts: understand tasks, agents, hosts, and reviews
Troubleshooting: if something isn't working