neuroskill-com/neuroskill-streaming

NeuroSkill Streaming & Control Commands

---

LLM Tool Calls

When calling these commands via the LLM skill tool, use command + args:

{"command": "say", "args": {"text": "Hello, how are you feeling?"}}
{"command": "notify", "args": {"title": "Focus Alert", "body": "Your focus dropped"}}
{"command": "label", "args": {"text": "meditation start"}}
{"command": "calibrate"}
{"command": "timer"}
{"command": "list_calibrations"}
{"command": "run_calibration", "args": {"id": 3}}

---

say — Text-to-Speech (On-Device TTS)

Speak text aloud through the Skill app's built-in TTS engine (espeak-ng). Fire-and-forget — the command returns immediately without waiting for speech to complete.

npx neuroskill say "Eyes open. Starting calibration."
npx neuroskill say "Break time. Stretch and breathe."
npx neuroskill say "Focus session complete." --voice Jasper
npx neuroskill say "Hello!" --json

--voice <name> — Optional. Specify a voice name (e.g. Jasper, Alex, m1, f1). Omit to use the voice last selected in Settings → Voice.

HTTP:

curl -s -X POST http://127.0.0.1:8375/ \
  -H "Content-Type: application/json" \
  -d '{"command":"say","text":"Focus session complete."}'

# With a specific voice:
curl -s -X POST http://127.0.0.1:8375/ \
  -H "Content-Type: application/json" \
  -d '{"command":"say","text":"Break time.","voice":"Jasper"}'

Response:

{ "command": "say", "ok": true, "spoken": "Eyes open. Starting calibration." }
// With voice:
{ "command": "say", "ok": true, "spoken": "Break time.", "voice": "Jasper" }

Requires espeak-ng on PATH. The first run may download the TTS voice model (~30 MB).

---

calibrations — List or Inspect Calibration Profiles

List all saved calibration profiles or fetch the full detail for one by ID.

npx neuroskill calibrations                         # list all profiles (default: list)
npx neuroskill calibrations list                    # same as above
npx neuroskill calibrations get 3                   # full detail for profile id=3
npx neuroskill calibrations --json | jq '.profiles[].name'
npx neuroskill calibrations --json | jq '[.profiles[] | {id: .id, name: .name}]'

HTTP:

curl -s -X POST http://127.0.0.1:8375/ \
  -H "Content-Type: application/json" \
  -d '{"command":"list_calibrations"}' | jq '.profiles[].name'

Response (list):

{
  "command": "list_calibrations",
  "ok": true,
  "profiles": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Eyes Open/Closed",
      "loop_count": 3,
      "break_duration_secs": 5,
      "auto_start": true,
      "actions": [
        { "name": "Eyes Open",   "duration_secs": 20 },
        { "name": "Eyes Closed", "duration_secs": 20 }
      ]
    }
  ]
}

Use calibrations to discover profile names/IDs, then pass them to calibrate --profile.

---

listen — Real-Time Event Streaming

Passively collect real-time broadcast events from the server for a fixed duration. Events include raw EEG packets, PPG, IMU, scores, and label-created notifications.

Requires WebSocket (--http mode has no push streaming).

npx neuroskill listen                         # 5 seconds (default)
npx neuroskill listen --seconds 30
npx neuroskill listen --seconds 10 --json
npx neuroskill listen --seconds 5 --json | jq '[.[] | select(.event == "scores")]'
npx neuroskill listen --seconds 5 --json | jq 'map(select(.event == "eeg")) | length'

JSON Event Shapes

// EEG packet (4 channels × N samples):
{ "event": "eeg", "electrode": 0, "samples": [12.3, -4.1], "timestamp": 1740412800.512 }

// PPG packet:
{ "event": "ppg", "channel": 0, "samples": [2048.1, 2051.3], "timestamp": 1740412800.512 }

// IMU packet:
{ "event": "imu", "ax": 0.01, "ay": -0.02, "az": 9.81, "gx": 0.0, "gy": 0.0, "gz": 0.0 }

// 5-second epoch scores:
{ "event": "scores", "focus": 0.70, "relaxation": 0.40, "engagement": 0.60,
  "rel_delta": 0.28, "rel_theta": 0.18, "rel_alpha": 0.32, "rel_beta": 0.17,
  "hr": 68.2, "snr": 14.3, "timestamp": 1740412805 }

// Label created:
{ "event": "label_created", "label_id": 43, "text": "distracted", "created_at": 1740412830 }

Hidden Fields

| Hidden field | Contents | |---|---| | events array | Full array of every raw broadcast event — default summary only prints counts |

npx neuroskill listen --seconds 10 --json | jq '[.[] | select(.event == "scores")]'
npx neuroskill listen --seconds 5  --json | jq '.[0]'

---

notify — OS Notification

Send a native OS notification through the NeuroSkill app.

npx neuroskill notify "Session complete"
npx neuroskill notify "Focus done" "Take a 5-minute break"
npx neuroskill notify "High drowsiness detected" "Consider a break"

HTTP:

curl -s -X POST http://127.0.0.1:8375/ \
  -H "Content-Type: application/json" \
  -d '{"command":"notify","title":"Session done","body":"Great work!"}'

Response: { "command": "notify", "ok": true }

# Verify in a script:
npx neuroskill notify "build finished" --json | jq -e '.ok' > /dev/null \
  && echo "notification sent" || echo "notification failed"

---

calibrate — Open Calibration Window

Open the calibration window and start a profile immediately. With --profile, matches by profile name (case-insensitive substring) or exact UUID.

npx neuroskill calibrate                              # uses active profile
npx neuroskill calibrate --profile "Eyes Open"        # by name
npx neuroskill calibrate --profile default            # by id
npx neuroskill calibrate --json | jq '.ok'

List all profiles (raw command):

npx neuroskill raw '{"command":"list_calibrations"}' --json | jq '[.profiles[].name]'

The list_calibrations response shape:

{
  "profiles": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Eyes Open/Closed",
      "loop_count": 3,
      "break_duration_secs": 5,
      "auto_start": true,
      "actions": [
        { "name": "Eyes Open",   "duration_secs": 20 },
        { "name": "Eyes Closed", "duration_secs": 20 }
      ]
    }
  ]
}

HTTP:

# List profiles:
curl -s -X POST http://127.0.0.1:8375/ \
  -H "Content-Type: application/json" \
  -d '{"command":"list_calibrations"}' | jq '.profiles[].name'

# Run a specific profile by UUID:
curl -s -X POST http://127.0.0.1:8375/ \
  -H "Content-Type: application/json" \
  -d '{"command":"run_calibration","id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}'

# Script usage:
npx neuroskill calibrate --profile "Eyes Open" --json | jq -e '.ok' > /dev/null \
  && echo "calibration started" || echo "failed — is a Muse connected?"

---

timer — Focus Timer

Open the Focus Timer window and auto-start the work phase using the last saved preset (Pomodoro 25/5, Deep Work 50/10, or Short Focus 15/5).

npx neuroskill timer
npx neuroskill timer --json   # → { "command": "timer", "ok": true }

HTTP:

curl -s -X POST http://127.0.0.1:8375/ \
  -H "Content-Type: application/json" \
  -d '{"command":"timer"}'

---

raw — Raw JSON Passthrough

Send any JSON payload to the server and print the raw response. Use this for commands not yet exposed as named CLI subcommands.

npx neuroskill raw '{"command":"status"}'
npx neuroskill raw '{"command":"sessions"}' --json
npx neuroskill raw '{"command":"search","start_utc":1740412800,"end_utc":1740415500,"k":3}'
npx neuroskill raw '{"command":"neurological"}' --json | jq '.neurological.headache_index'
npx neuroskill raw '{"command":"label","text":"retrospective note","label_start_utc":1740412800}'

HTTP:

# The raw command body is forwarded verbatim:
curl -s -X POST http://127.0.0.1:8375/ \
  -H "Content-Type: application/json" \
  -d '{"command":"search","start_utc":1740412800,"end_utc":1740415500,"k":3}'