/SKILL.md
Skill index and overview — lists all available NeuroSkill skills, tools, and explains how skill loading works.
npx skillsauth add neuroskill-com/skills neuroskill-indexInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
NeuroSkill is a biometric AI companion powered by a real-time EEG device. It reads brainwaves and physiology continuously, and uses that data to inform every response.
NeuroSkill exposes the EEG analysis API through a local WebSocket server and HTTP tunnel.
The npx neuroskill <command> CLI is the fastest way to query it from a terminal, shell
script, or any automation pipeline.
Skills are loaded contextually — the LLM loads the relevant skill file into its context when the user's message matches the skill's domain.
| Skill | Loaded when | Description |
|---|---|---|
| neuroskill-transport | transport/connection questions | WebSocket & HTTP transport, port discovery, Quick Start, output modes (--json / --full), and global CLI flags. |
| neuroskill-status | status/device questions | status command — full system snapshot: device state (4 device types), signal quality, EEG scores, band powers, ratios, hooks summary, embeddings, labels, sleep summary, and recording history. |
| neuroskill-sessions | session/history questions | session and sessions commands — per-session metric breakdowns with first/second-half trends, session listing, and Unix timestamp helpers. |
| neuroskill-search | comparison/trend questions | search and compare commands — ANN search for neurally similar EEG moments across all history, and A/B session comparison with metric deltas and UMAP enqueuing. |
| neuroskill-sleep | sleep/fatigue context | sleep and umap commands — EEG-based sleep stage classification (Wake/N1/N2/N3/REM) with efficiency and bout analysis, and 3D UMAP projection for spatial session comparison. |
| neuroskill-labels | label/search context | label, search-labels, and interactive commands — creating EEG text annotations, semantic vector search over labels, and cross-modal 5-layer graph search combining text, EEG similarity, and screenshot discovery with 3D visualization. |
| neuroskill-streaming | streaming/calibration/TTS context | say, listen, notify, calibrate, calibrations, timer, and raw commands — on-device TTS speech, real-time WebSocket event streaming, OS notifications, calibration profile management, focus timer, and raw JSON passthrough. |
| neuroskill-hooks | hooks/automation context | hooks command — Proactive Hooks CRUD, real-time EEG pattern matching with scenario gating (cognitive/emotional/physical), threshold suggestions, WebSocket broadcast triggers, and audit logging. |
| neuroskill-terminal | terminal/shell/command tracking | terminal command — OS-wide shell hook management (install/uninstall/status for zsh/bash/fish/PowerShell), tracked terminal commands, brain-fused terminal impact analysis, dev loop detection, context switch cost. |
| neuroskill-dnd | DND/focus-mode context | dnd command — EEG-driven Do Not Disturb automation, rolling focus score average, OS-level DND state, and force-override on/off. |
| neuroskill-calendar | calendar/schedule/meetings/events questions | calendar command — OS calendar events via EventKit (macOS), iCal files (Linux/Windows); fetch by range, check access status, request permission. |
| neuroskill-screenshots | screenshot/OCR/vision search context | search-images, screenshots-around, screenshots-for-eeg, and eeg-for-screenshots commands — search screenshots by OCR text (semantic or substring), by visual similarity (CLIP --by-image), find screenshots near a timestamp or EEG session, and cross-modal EEG↔screenshot bridging (find brain state for screen content, or screen content for brain state). |
| neuroskill-data-reference | metric field questions | All metric fields — band powers, EEG ratios and indices, core scores, complexity measures, PPG/HRV, motion and artifact markers, sleep stage codes, neurological indices, and consciousness metrics. |
| neuroskill-recipes | scripting/automation questions | Use-case recipes and scripting patterns — focus monitoring, stress tracking, sleep analysis, cognitive load queries, meditation tracking, cross-modal graph search, A/B comparison, time-range queries, and automation with cron/Python/Node.js/HTTP. |
| Skill | Loaded when | Description | |---|---|---| | neuroskill-llm | LLM/chat/model questions | Built-in on-device LLM inference server — model catalog management (add/download/select/delete GGUF models), vision support (mmproj), streaming WebSocket and HTTP chat, automatic tool calling, GenParams tuning, persistent chat history, and OpenAI-compatible API. |
| Skill | Loaded when | Description |
|---|---|---|
| neuroskill-evidence | any intervention, protocol, habit tracking, or "what works for me?" question | Implicit evidence collection and personal effectiveness engine — standardised px: label schema, automatic before/after measurement, outcome scoring, personal protocol ranking, life-event tracking, evidence-driven selection rules, and privacy safeguards. All other skills that deliver interventions MUST follow this skill's rules. |
| neuroskill-protocols | any protocol/exercise/routine intent detected | Protocol framework hub — personalisation engine, API integration guide, modality router, matching guidance, and index of 11 domain sub-skills. Always loaded alongside domain sub-skills. |
| neuroskill-protocols-focus | focus, attention, cognitive load, energy, alertness, flow, creativity | Focus, attention, cognition, consciousness, and energy/alertness protocols. |
| neuroskill-protocols-meditation | meditation, mantra, visualization, loving-kindness, body scan, open awareness, neurofeedback meditation | Meditation protocols — focused attention, open monitoring, mantra, visualization, loving-kindness, body scan, walking meditation, and EEG-biofeedback meditation. |
| neuroskill-protocols-mindfulness | mindfulness, present-moment awareness, noting, RAIN, STOP, grounding, urge surfing, mindful eating, thought defusion | Mindfulness protocols — noting, mindful breathing/eating/walking/listening, STOP, RAIN, 5-4-3-2-1 grounding, thought defusion, self-compassion, equanimity, and urge surfing. |
| neuroskill-protocols-stress | stress, anxiety, relaxation, HRV, calm, overwhelm, breathing exercises | Stress, relaxation, autonomic regulation, HRV, hemispheric balance, and deep relaxation protocols. |
| neuroskill-protocols-emotions | emotions, mood, anger, grief, sadness, shame, fear, loneliness, joy | Emotional regulation, mood, and extended emotional processing protocols (12 specific emotions). |
| neuroskill-protocols-sleep | sleep, insomnia, nap, rest, recovery, NSDR, tired | Sleep, circadian, recovery, NSDR/yoga nidra, and power nap protocols. |
| neuroskill-protocols-body | body, tension, neck, headache, eye strain, posture, pain, grounding | Body, somatic, neck/cervical, eye exercise, headache/migraine, and motor protocols. |
| neuroskill-protocols-routines | morning routine, gym, workout, exercise, hydration, break | Morning routines, workout/gym, hydration, and movement break protocols. |
| neuroskill-protocols-nutrition | food, diet, nutrition, caffeine, fasting, meal, cravings, alcohol | Dietary, nutrition, caffeine timing, fasting, eating, and gut-brain protocols. |
| neuroskill-protocols-music | music, playlist, listening, binaural beats, singing | Music protocols — genre/BPM/artist suggestions for mood, focus, stress, sleep, and emotional release. |
| neuroskill-protocols-digital | social media, phone, screen time, scrolling, digital detox, FOMO | Social media, digital addiction, screen time, and attention restoration protocols. |
| neuroskill-protocols-breathfree | non-breathing, breath-free, alternative, tactile, fidget, cold water | 30+ non-breathing alternatives — cognitive, tactile, oculomotor, micro-movement, auditory, and passive physiological. |
| neuroskill-protocols-life | parent, elderly, teen, student, ADHD, autism, commute, shift work, relationship, disability, cultural | Context-specific protocols for 11 life situations — parenting, aging, teens, neurodivergent, commuters, manual workers, healthcare, relational, accessibility, cultural, and situational. |
The built-in LLM chat has access to these tools (enabled in Settings > LLM > Tools):
| Tool | Purpose |
|---|---|
| date | Get current date/time metadata (Unix timestamps, timezone, local/UTC). |
| location | Approximate public-IP geolocation (country/region/city/timezone). |
| bash | Execute shell commands and return stdout/stderr. |
| read_file | Read file contents from disk. |
| write_file | Write / create files. |
| edit_file | Surgical find-and-replace edits in files. |
| search_output | Navigate large tool outputs (paginated regex/head/tail). |
| web_search | Search the web and return results. |
| web_fetch | Fetch a URL and return its content. |
| skill | Query the NeuroSkill EEG API (status, sessions, labels, search, hooks, DND, calibrations, TTS, etc.). |
Skills are discovered automatically from:
~/.skill/skills/ — user-global skills<project>/.skill/skills/ — project-local skillsskills/ directory (this repository)Each skill has a SKILL.md with YAML frontmatter (name, description). On LLM server
startup, all skills are discovered and their names/descriptions are injected into the system
prompt as an <available_skills> XML block. When the user's task matches a skill's description,
the LLM uses the read_file tool to load the full instructions from the SKILL.md file.
tools
NeuroSkill EEG API transport layer — WebSocket and HTTP protocols, port discovery, Quick Start, output modes (default/--json/--full), and global CLI flags. Use when setting up a connection, choosing transport, or understanding output format options.
development
NeuroSkill `say`, `listen`, `notify`, `calibrate`, `calibrations`, `timer`, and `raw` commands — on-device TTS speech, real-time WebSocket event streaming, OS notifications, calibration profile management, focus timer, and raw JSON passthrough. Use when streaming live EEG events, speaking text aloud, sending alerts, starting calibration, or sending arbitrary commands.
development
NeuroSkill `status` command — full system snapshot including device state, signal quality, EEG scores, band powers, ratios, embeddings, labels (with top texts), app usage (top apps by time), screenshots (OCR counts + top apps), hooks summary, sleep summary, and recording history. Use when checking current EEG state, device connection, session metadata, what apps were used, or screenshot statistics.
testing
NeuroSkill `sleep` and `umap` commands — EEG-based sleep stage classification (Wake/N1/N2/N3/REM) with efficiency and bout analysis, and 3D UMAP projection of session embeddings for spatial comparison. Use when analysing sleep quality or visualising neural state separation between sessions.