Guides
Quickstart
GuideFrom clone to first memory in five minutes. Host prerequisites, the docker compose boot, a health check, your first memory and search query.
Open →Your first agent
GuideWrite a minimal agent against the Consciousness Server HTTP API in 40 lines of Python. Register, log a conversation, drop a note, search, coordinate with peers.
Open →Connecting Cortex
GuidePlug Cortex — the reference local-first agent — into a running Consciousness Server. Auto-discovery means no env vars for the common case. Includes the three-agent multi-Cortex demo coordinating through CS chat and task queues.
Open →Secure deployment
GuideWalk the AUTH_MODE migration from off to observe to enforce. Generate ed25519 keys, bootstrap them, watch the observe log, flip — without breaking live agents.
Open →Document pipeline
GuideParse PDFs and DOCX on the host with Document Processor, then push the structured output into Consciousness Server as searchable training records. End-to-end RAG without anything leaving the machine.
Open →Multi-machine fleet
GuideRegister multiple machines with machines-server, route agents to whichever node has the right GPU and model loaded, and watch live telemetry.
Open →Product pages
Each product page is its own narrative reference: what the component does, what it runs, and the exact commands.
Consciousness Server
Shared memory, semantic search, agent and skill registry, machines awareness, ed25519 auth. Six HTTP services on one compose.
Open →Cortex
Local AI agent with tool calling, powered by Ollama. CLI, Web UI, worker mode. Multi-model orchestration. Plugs into the shared memory layer.
Open →Document Processor
Desktop app for PDF / DOCX / TXT with image-and-context extraction. For documents that must not leave the host.
Open →BuildOnAI Key Server
ed25519 signature-per-request authentication for any HTTP service. Optional on-disk vault for SSH keys and API tokens. Three AUTH_MODE values for safe migration.
Open →Machines
Every workstation, app host or edge node as a first-class entity with hardware profile, available models, and live telemetry.
Open →Reference material
Authoritative reference for each repository lives in the repo itself, alongside the code:
- consciousness-server / ARCHITECTURE.md — API contracts, data shapes, AUTH_MODE matrix.
- consciousness-server / SECURITY.md — threat model, scope by AUTH_MODE.
- cortex / ARCHITECTURE.md — CLI, Web UI, worker mode, Recovery Engine, Policy Engine.
- cortex / SECURITY.md — Policy Engine semantics and the structural defence against prompt injection.
- document-processor / SECURITY.md
- buildonai-key-server / SECURITY.md