Skip to content

Project Structure

Raul Montoya Cardenas edited this page Jul 29, 2026 · 2 revisions

Project Structure

Wiki hero

Generated with Grok Build: Grok 4.5 · xAI Imagine (/imagine)

Repository Layout

brainstem-daemon/
├── src/
│   ├── lib.rs              # Module tree + public re-exports
│   ├── daemon.rs           # DaemonConfig, BrainstemDaemon, tick loop
│   ├── backend.rs          # Traits, stub, optional ZMQ impl
│   ├── registry.rs         # ServiceConfig, ServiceRegistry
│   └── bin/soma_daemon.rs  # CLI entry: config load, backend select, run
├── .github/workflows/ci.yml
├── Dockerfile              # multi-stage: base → core | full → final
├── Cargo.toml / Cargo.lock
├── AGENTS.md               # Agent guidance (Cursor Cloud notes)
├── CHANGELOG.md
├── README.md
├── LICENSE-MIT / LICENSE-APACHE-2.0
└── .devin/blueprint.yaml   # Devin environment lint/test/build knowledge

Modules

Module Responsibility
daemon TOML config, daemon lifecycle, run_tick, neuromod step, validation
backend IngressPacket, SpikeEvent, traits, stub, #[cfg(feature = "corpus-ipc")] ZMQ
registry Config-driven named services map

Cargo Features

Feature Default Effect
(none) yes Stub backend only; no corpus-ipc / zmq deps
corpus-ipc off Enables corpus-ipc git dep + zmq; ZMQ source/sink types

Temporary decoupling (issues #10–14 / PR #24): core quality work must not require system ZeroMQ. neuromod remains a hard dependency (optionalization tracked separately, #15–19).

Package Metadata

Field Value
name brainstem-daemon
version 0.1.2
edition 2024
binary soma-daemonsrc/bin/soma_daemon.rs

Dependencies (high level)

Dep Role
neuromod 0.4 SpikingNetwork, NeuroModulators
tokio Current-thread runtime, interval, Ctrl+C
clap, serde, toml, tracing* CLI, config, logs
anyhow, dirs Errors, config path
corpus-ipc + zmq Optional spine I/O

Agent / Devin notes

.devin/blueprint.yaml installs libzmq3-dev, rustfmt, clippy; knowledge entries:

  • lint: fmt --check + clippy all-features -D warnings
  • test: cargo test --all-features
  • build: release soma-daemon
  • note: default = stub; --all-features for ZeroMQ

Last updated: July 28, 2026 Updated by: Grok Build: Grok 4.5 Package tip reference: 8176c58 (main)

Clone this wiki locally