mnemos AGENTS.md

AGENTS.md — machine-readable install guide for MNEMOS

This file lets an automated agent install/deploy MNEMOS for an operator given a requested set of modules, deterministically. Human guide: docs/INSTALL.md.

The pip package is mnemos-core. mnemos is an image name, not a pip package — never run pip install mnemos or pip install mnemos-os.

Module registry

# id -> how to obtain it. Subsystems share the mnemos.* namespace and are
# runtime-gated: installing the dist mounts the routes; absence => HTTP 503.
modules:
  core:       { dist: mnemos-core,     extra: null,       kind: kernel,   arch: [amd64, arm64] }
  graeae:     { dist: mnemos-graeae,   extra: graeae,     kind: router,   arch: [amd64, arm64] }
  pantheon:   { dist: mnemos-pantheon, extra: pantheon,   kind: router,   arch: [amd64, arm64] }
  knemon:     { dist: mnemos-knemon,   extra: knemon,     kind: router,   arch: [amd64, arm64] }
  charon:     { dist: mnemos-charon,   extra: charon,     kind: router,   arch: [amd64, arm64] }
  stiphos:    { dist: mnemos-stiphos,  extra: null,       kind: service,  arch: [amd64, arm64], port: 8080, note: "separate service, not in the everything image" }

backends:           # selected at RUNTIME via MNEMOS_DATABASE_DSN, not by image
  sqlite:   { driver: bundled,  dsn: "sqlite:////data/mnemos.db", arch: [amd64, arm64], default: true }
  postgres: { driver: asyncpg,  dsn: "postgres://USER:PASS@HOST:5432/DB", arch: [amd64, arm64] }
  oracle:   { driver: oracledb, extra: oracle, dsn: "oracle://USER:PASS@HOST:1521/SERVICE", arch: [amd64, arm64], thin: true }
  db2:      { driver: ibm_db,   extra: db2,    dsn: "db2://USER:PASS@HOST:50000/DB", arch: [amd64] }
  mysql:    { driver: aiomysql, extra: mysql,  dsn: "mysql://USER:PASS@HOST:3306/DB", arch: [amd64, arm64] }
  mariadb:  { driver: aiomysql, extra: mysql,  dsn: "mariadb://USER:PASS@HOST:3306/DB", arch: [amd64, arm64] }

accelerators:       # OPTIONAL embedder accel; default is portable CPU llama-cpp
  openvino: { extra: openvino, arch: [amd64] }          # Intel x86-only
  cuda:     { extra: cuda,     arch: [amd64, arm64] }    # needs PyTorch CUDA index
  amd:      { extra: amd,      arch: [amd64] }           # ROCm, linux-only

images:
  mnemos-core:       { ref: "ghcr.io/ncz-os/mnemos-core",       contains: [core],                              arch: [amd64, arm64], port: 5002 }
  mnemos:            { ref: "ghcr.io/ncz-os/mnemos",            contains: [core, graeae, pantheon, knemon, charon], arch: [amd64, arm64], port: 5002, canonical_everything: true }
  mnemos-enterprise: { ref: "ghcr.io/ncz-os/mnemos-enterprise", contains: [core, graeae, pantheon, knemon, charon, oracle, db2, mysql], arch: [amd64], port: 5002, note: "the mysql driver (aiomysql) also serves the mariadb backend" }
  mnemos-stiphos:    { ref: "ghcr.io/ncz-os/mnemos-stiphos",    contains: [stiphos],                           arch: [amd64, arm64], port: 8080 }