Files
Cortex-Inara/documentation/MASTER.md
Scott Idem a92fd90f0d feat: Anthropic SDK backend — API key alternative to Claude CLI OAuth
Adds `anthropic_api` model type so users can authenticate with a direct
Anthropic API key instead of (or alongside) the CLI OAuth session.

- model_registry.py: `anthropic_api` type; `save/get/remove_anthropic_api_key()`
  mirroring the Google account pattern; `save_cloud_model()` now picks type
  based on credential type (cli → claude_cli, api_key → anthropic_api);
  `_resolve_model()` merges api_key from the credential entry
- llm_client.py: `_anthropic_api()` backend (AsyncAnthropic SDK); dispatch
  and fallback wiring; usage tracking
- routers/local_llm.py: Anthropic API key management routes
  (POST /settings/local/anthropic-key, /anthropic-key/{id}/remove);
  `anthropic_api` badge and edit-form credential selector
- static/local_llm.html: Anthropic Cloud Provider block now shows API key
  management (add/remove); Add Model → Anthropic tab has credential selector
  (CLI vs API key)
- requirements.txt: enable anthropic>=0.40.0

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-13 21:30:56 -04:00

5.8 KiB

Cortex / Inara — Master Index

Start here. This document is a map, not a manual. Last updated: 2026-05-13

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 (62 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 5 job types: remind, note, message, brief, task (full orchestrator loop) → NC Talk / web push
Schedules web UI Live /settings/crons — view, add, edit, pause/resume, delete jobs without going through the AI
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
Proactive notifications Live Daily reminder check (09:00); distill/cron completion alerts; dedicated /settings/notifications page
Sub-agent spawning Live spawn_agent tool — synchronous sub-agents via any configured model
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

65 orchestrator tools across 17 domain modules — added 2026-05-12: file_diff, git_status / git_log / git_diff (read-only git inspection), ae_db_query / ae_db_describe / ae_db_show_view (SELECT-only Aether MariaDB access, admin, per-user credentials). /settings/integrations page added (admin-only). File attachments in chat (images for vision-capable local models; text/code files for all backends). Settings pages unified under pg.css. Added 2026-05-13: task cron type (full orchestrator loop on a schedule); monthly/yearly schedule formats (monthly, monthly:DD:HH:MM, yearly:MM:DD:HH:MM); Schedules web UI at /settings/crons (list, add, edit, pause, delete); HA inbound webhook tools toggle (orchestrator vs. direct LLM); Anthropic API key backend (anthropic_api model type via Anthropic SDK — alternative to CLI OAuth).

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)
SELF_UPDATE.md Bootstrap for agents doing self-maintenance — git, Syncthing, scripts, doc checklist

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