Skip to content

README.md

Latest commit

 

History

History
127 lines (90 loc) · 6.79 KB

README.md

File metadata and controls

127 lines (90 loc) · 6.79 KB

AnimaWorks Documentation

日本語

No one can do anything alone. So I built an organization.

A team of imperfect individuals will always outperform a lone genius. As a psychiatrist examining LLMs, I saw the same architecture as the human brain. So I gave them the same kind of memory — the kind that accumulates experience, distills lessons, and forgets what no longer matters. A growing team of people, defined in code. That's AnimaWorks.

This page is your starting point for understanding the whole picture.

Where to Start

Getting up and running

  1. Features — What AnimaWorks can do, end to end
  2. CLI Reference — Every command from setup to daily operations
  3. API Reference — REST API specification for the web UI and scripting
  4. Slack Integration — Connect Slack to your Animas (no public URL required)

Understanding the architecture

  1. Vision — The core philosophy: imperfect individuals collaborating beats a single omniscient model
  2. Technical Spec — Execution modes, prompt construction, configuration resolution
  3. Memory System — Episodic, semantic, and procedural memory; priming; forgetting
  4. Security — Defense-in-depth model and adversarial threat analysis

Neuroscience and research

  1. The Context Window Illusion — Why bigger context doesn't mean better cognition, and the case for biologically-inspired memory
  2. Brain Mapping — How each AnimaWorks module maps to a region of the human brain
  3. Memory System — The hippocampus, neocortex, and basal ganglia, reimplemented in code
  4. Vision — Why a psychiatrist built this framework

All Documents

Core Concepts

Document Description
Vision "Imperfect individuals collaborating create a more resilient organization than a single omniscient model." Encapsulation, library-style memory, autonomy, and heterogeneous multi-model design
Features Autonomous agents, memory lifecycle, organizational hierarchy, multi-model support, voice chat, and everything else AnimaWorks does

Reference

Document Description
CLI Reference Every animaworks subcommand and option — initialization, server management, Anima operations, chat, model management, RAG indexing
API Reference All REST endpoints — authentication, Anima management, chat (SSE streaming), memory operations, configuration, webhooks
Slack Integration Step-by-step Socket Mode setup. Create the Slack App, configure tokens, connect to your Animas. Works behind NAT

Architecture Deep Dive

Document Description
Technical Spec Full specification. Four execution modes (S/A/B/C), 6-group prompt construction, 3-pass execution isolation, configuration resolution precedence
Memory System Mapping to human memory models, RAG retrieval, 6-channel parallel priming, daily/weekly consolidation, 3-stage active forgetting
Security Threat model, data provenance tracking, trust-level classification, command execution control, path traversal defense, authentication
Brain Mapping LLM as neocortex, priming as hippocampus, forgetting as sleep-dependent homeostasis. Designed from clinical psychiatric experience

Research

Document Description
The Context Window Illusion Context utilization degrades beyond 10–30%. Structural parallels with psychiatric cognitive impairment. The case for biologically-inspired memory architecture

Release Notes

Version Description
v0.5 Full RAG migration, 4-phase provenance security, Workspace UI overhaul, streaming performance 3–5x improvement

Design Specs (specs/)

Implementation specifications for individual features. Useful for contributors or anyone who wants to understand the engineering decisions behind AnimaWorks.

Memory System

Date Spec
2026-02-14 Priming Layer Design
2026-02-18 Priming Format Redesign
2026-02-18 Unified Activity Log
2026-02-18 Activity Log Spec Compliance
2026-02-18 Streaming Journal (WAL)
2026-02-18 Episode Dedup, State Auto-update, Resolution Propagation
2026-02-18 Consolidation Validation Pipeline
2026-02-18 Knowledge Contradiction Detection & Resolution
2026-02-18 Memory System Enhancement Checklist

Procedural Memory

Date Spec
2026-02-18 Procedural Memory Foundation
2026-02-18 Procedural Memory Auto-distillation
2026-02-18 Procedural Memory Reconsolidation
2026-02-18 Procedural Memory Utility & Forgetting

Security

Date Spec
2026-02-15 Memory Write Security
2026-02-28 Command Injection Fix
2026-02-28 Path Traversal Fix

Data Provenance

Date Spec
2026-02-28 Phase 1: Foundation
2026-02-28 Phase 2: Input Boundary
2026-02-28 Phase 3: Propagation
2026-02-28 Phase 4: RAG Provenance
2026-02-28 Phase 5: Mode S Trust

Tools

Date Spec
2026-03-07 Generic Notion Tool