Project Memory¶
Project memory is the .neuroflow/ folder at the root of your project repository.
It is the shared brain of your neuroflow project โ a set of structured Markdown and JSON files that every command reads at the start of a session and writes to at the end. This means Claude always knows your research question, your active phase, and what has been done before โ without you having to re-explain anything.
Structure¶
.neuroflow/
โโโ project_config.md โ current phase, research question, modality, tools, plugin_version
โโโ flow.md โ index of all subfolders
โโโ sentinel.md โ sentinel audit report
โโโ linked_flows.md โ paths to other .neuroflow/ folders (optional)
โโโ team.md โ project members and roles (optional)
โโโ timeline.md โ milestones and deadlines (optional)
โโโ sessions/ โ one .md per day โ add to .gitignore
โโโ reasoning/ โ structured per-phase decision logs (JSON)
โโโ ethics/ โ IRB documents, consent forms
โโโ preregistration/ โ OSF / AsPredicted documents
โโโ finance/ โ grant documents, expense tracking
โโโ ideation/ โ research questions, proposals, literature reviews
โโโ grant-proposal/ โ grant application drafts
โโโ experiment/ โ paradigm scripts, recording setup docs
โโโ tool-build/ โ tool specs and build notes
โโโ tool-validate/ โ validation plans and results
โโโ data/ โ data inventory and intake reports
โโโ data-preprocess/ โ preprocessing configs and QC reports
โโโ data-analyze/ โ analysis plans and result summaries
โโโ paper/ โ manuscript drafts and critic logs
โโโ notes/ โ structured notes from meetings and talks
โโโ write-report/ โ project reports
Key files¶
project_config.md¶
The most important file in .neuroflow/. Every command reads this first. It contains:
- Project name and institution
- Active phase โ which pipeline phase is currently in progress
- Research question โ the core scientific question
- Modality โ EEG, fMRI, iEEG, eye tracking, etc.
- Tools โ Python/MNE, MATLAB, R, etc.
plugin_versionโ tracked by sentinel to flag plugin updates- Output paths โ where each phase writes its files (code, results, figures, manuscripts)
Example:
# project_config.md
project: OddballStudy2026
institution: Charles University, Prague
plugin_version: 0.1.2
active_phase: data-preprocess
research_question: Does white noise background (65 dB) reduce P300 amplitude
in a visual oddball task compared to silence?
modality: EEG (BrainProducts actiCHamp, 64 ch)
tools: Python 3.11, MNE 1.6, PsychoPy 2024
## Output paths
| Phase | Path |
|---|---|
| experiment | paradigm/ |
| data-preprocess | scripts/preprocessing/ |
| data-analyze | scripts/analysis/, results/, figures/ |
| paper | manuscript/ |
flow.md¶
An index of everything in .neuroflow/. Each subfolder has its own flow.md too โ an index of the files inside it. Commands use flow.md to navigate without scanning the whole disk.
reasoning/¶
Structured per-phase decision logs in JSON format. Each entry has three fields:
{
"statement": "Using average reference instead of linked mastoids",
"source": "data-preprocess session 2026-03-05",
"reasoning": "Linked mastoids are not appropriate for this cap layout; average reference is standard for 64-channel EEG"
}
sessions/¶
One Markdown file per day, automatically appended to by every command. Gives you a chronological log of what was done.
Add to .gitignore
Session logs are local โ they may contain personal notes and intermediate thoughts. Add .neuroflow/sessions/ to your .gitignore.
How commands use project memory¶
Every command follows the same lifecycle:
1. Read neuroflow-core skill โ understand the lifecycle rules
2. Read project_config.md โ orient to the current project
3. Read root flow.md โ understand what has been done
4. Read phase-specific flow.md โ understand what exists in this phase
5. Do the work (interact with user)
6. Write outputs to phase subfolder
7. Update flow.md
8. Append to sessions/YYYY-MM-DD.md
9. Update project_config.md if phase changed
This means every command has full project context without you needing to paste anything.
Multiple projects¶
You can link multiple .neuroflow/ folders using linked_flows.md:
# linked_flows.md
- ../related-study/.neuroflow/ โ pilot data from a related project
- ../grant-project/.neuroflow/ โ the parent grant this study is part of
The sentinel agent checks that all listed paths resolve to actual folders.
Git recommendations¶
# Add to your project .gitignore:
.neuroflow/sessions/ # local daily logs
.neuroflow/integrations.json # credential file (already excluded by neuroflow)
Everything else in .neuroflow/ should be git-tracked โ it is the shared memory of your project and should be part of the repo.