Tool audit log:
- Every orchestrator tool call logged to home/{user}/tool_audit/YYYY-MM-DD.jsonl
- Files panel sidebar: audit log group (collapsed), date-linked read-only table
- Admin endpoints: /api/audit/files, /api/audit/day, /api/audit/recent, /api/audit/stats
- Engine and model name recorded per entry
OpenAI orchestrator improvements:
- Context budget enforcement: 75% of model context_k (min 16k)
- Message compaction: truncates old tool results when approaching budget
- max_rounds respected per model config (intersected with server cap)
OpenRouter onboarding (setup.html, onboarding.py, app.js, settings.html):
- Step 3 of 3: /setup/model with curated model picker
- Chat banner for users on server-default model (informational, not alarmist)
- Settings quick-link card; /setup/model works standalone for existing users
Model registry + session store:
- set_role_config / get_role_config for per-role tool lists and system_append
- session_store: session rename, session name backfill endpoint
UI updates (app.js, index.html, style.css, local_llm.html):
- Role toggle in context panel
- Off-the-record mode
- Agent notes read-only viewer
- OPERATIONS.md loaded at T2+ in context
Documentation:
- HELP.md: full tool table, per-role tool sets, Agent Notes, usage tracking
- TOOLS.md: Agent Notes section, count corrected to 44
- ARCH__SYSTEM.md, ARCH__BACKENDS.md, MASTER.md updated to match reality
- CLAUDE.md: onboarding flow, documentation philosophy sections
- README.md: stack in practice, DeepSeek TUI mention, architecture diagram updated
- TODO__Agents.md: onboarding task completed with deviation notes
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
4.4 KiB
4.4 KiB
Cortex / Inara — Master Index
Start here. This document is a map, not a manual. Last updated: 2026-05-06
Documentation philosophy: Cortex is a no-black-box system. Docs must match reality. Update docs before implementing significant changes. Verify they still match after.
What It Is
Cortex is a self-hosted personal AI platform. It routes messages from any input channel to AI backends, manages a resident agent (Inara) with persistent memory, and coordinates across a fleet of machines. It is infrastructure, not a product.
Running at: https://cortex.dgrzone.com | systemctl --user restart cortex
Current State
| Component | Status | Notes |
|---|---|---|
| Web UI | ✅ Live | SPA, dark theme, mobile-responsive, PWA-installable |
| Nextcloud Talk bot | ✅ Live | HMAC-signed, per-user routing |
| Google Chat Add-on | ✅ Live | JWT-verified, per-user routing |
| Claude backend | ✅ Live | Primary — via Claude Code CLI |
| Gemini backend | ✅ Live | Fallback — via Gemini CLI |
| Local backend | ✅ Live | Open WebUI/Ollama on scott_gaming; per-user multi-model config |
| Gemini orchestrator | ✅ Live | Tool loop → Claude response, ⚡ toggle in UI (40 tools) |
| Local orchestrator | ✅ Live | OpenAI-compatible ReAct loop; used when orchestrator role → local model |
| Model registry V2 | ✅ Live | Providers (Anthropic/Google/Local), multi-account Gemini, role assignments |
| Memory distillation | ✅ Live | Short (daily) / Mid (weekly) / Long (monthly) |
| Multi-user | ✅ Live | Scott, Holly, Brian — each with own personas |
| Session search | ✅ Live | Full-text search across past session logs |
| Proactive cron | ✅ Live | message and brief job types → NC Talk / web push |
| Tool audit log | ✅ Live | Every orchestrator tool call logged to home/{user}/tool_audit/ |
| Token usage tracking | ✅ Live | Per-user daily buckets in home/{user}/usage.json; visible in Settings |
| Web push notifications | ✅ Live | VAPID push; web_push orchestrator tool; subscribe via ☰ menu |
| Agent private notes | ✅ Live | AGENT_NOTES.md — orchestrator-only notepad; 3 rolling backups; user-visible as read-only |
| Distill safety | ✅ Live | Per-persona asyncio lock, per-endpoint cooldowns, Rebuild option |
| Guided onboarding | ✅ Live | Setup Step 3 for OpenRouter; existing-user banner; settings quick-link |
Active users / personas: scott/inara, holly/tina, brian/wintermute
Document Map
Project-Level
| Doc | What it covers |
|---|---|
| This file | Index and current state |
CORTEX.md |
Vision, philosophy, "what it is and isn't" |
ROADMAP.md |
Phases — what's done, what's next, what's deferred |
TODO__Agents.md |
Active task list — read before starting work |
Architecture
| Doc | What it covers |
|---|---|
ARCH__SYSTEM.md |
Overall architecture, component map, key design decisions |
ARCH__BACKENDS.md |
LLM backends, routing, fallback, per-user config |
ARCH__PERSONA.md |
Persona system, context tiers, memory distillation |
ARCH__CHANNELS.md |
Input channels — web, NC Talk, Google Chat, cron |
ARCH__FUTURE.md |
Planned: local orchestrator, dev agents, knowledge layer |
Setup & Reference
| Doc | What it covers |
|---|---|
docs/NEXTCLOUD_TALK_BOT.md |
NC Talk bot setup and troubleshooting |
docs/GOOGLE_CHAT_BOT.md |
Google Chat Add-on setup |
docs/OPEN_WEBUI_API.md |
Open WebUI/Ollama API reference for local model work |
Code-Level
| Doc | What it covers |
|---|---|
CLAUDE.md |
Project instructions for Claude Code — directory map, run commands, design decisions |
README.md |
Project root orientation, quick-start, user management |
cortex/static/HELP.md |
In-app help (rendered in UI for all users) |
Quick Reference
Start the service / check logs
systemctl --user restart cortex
journalctl --user -u cortex -f
Syntax check before restart
python3 -m py_compile cortex/<file>.py
Add a user
cd cortex && .venv/bin/python manage_passwords.py invite <username> <email>
Run tests
cd cortex && .venv/bin/python -m pytest tests/ -q