passepartout/README.org

OpenCortex: Your Autonomous, Plain-Text Life Assistant

• Meet OpenCortex
• The v0.2.0 Experience: Standard & Sovereign
• Quick Start
• The Onboarding Trifecta
• Project Documentation
• Architecture
• License

Meet OpenCortex

OpenCortex is an AI that lives inside your own text files.

It is a sovereign neurosymbolic AI agent and 100-year Memex, built on a minimalist Lisp kernel. It organizes your life, executes tasks, and gardens your knowledge base—all while maintaining 100% data ownership in plain-text Org-mode files.

The v0.2.0 Experience: Standard & Sovereign

With the v0.2.0 (Interactive Refinement) milestone, OpenCortex has reached a production-grade foundation:

• Minimalist Kernel: A purified Lisp harness targeting only core I/O and memory.
• Sovereign Skills: High-level capabilities (Diagnostics, Config, LLMs) are now modular skills.
• POSIX/XDG Compliance: Full alignment with Linux standards (~/.config, ~/.local/share).
• Professional TUI: A native Lisp interface with semantic highlighting and history scrolling.

Quick Start

To begin your journey with OpenCortex, you need a Common Lisp environment (SBCL).

# 1. Clone the repository
git clone https://ssh://git@10.10.10.201:2222/amr/opencortex.git ~/memex/projects/opencortex

# 2. Run the Modular Setup Wizard
cd ~/memex/projects/opencortex
./opencortex.sh setup

# 3. Verify your System Health
opencortex doctor

# 4. Enter the Brain
opencortex tui

The Onboarding Trifecta

1. `opencortex setup`: Guided Lisp-based configuration for multiple LLM providers (Ollama, Groq, OpenRouter, etc.).
2. `opencortex link <platform> <token>`: Securely connect external chat gateways like Telegram.
3. `opencortex doctor`: Real-time diagnostic report of your system health and environment.

Project Documentation

OpenCortex is built using Literate Programming. The documentation is the code.

• User Manual: Detailed guide on configuration, XDG paths, and commands.
• The Evolutionary Roadmap: Long-term vision and milestone progress.
• Contributing: Learn how to implement new sovereign skills.

Architecture

• Harness (Kernel): TCP Bridge, Merkle-Memory, Literate Loader.
• Skills (Userland): Diagnostics, Configuration, LLM Gateway, Shell Actuation.
• Interface: Native Croatoan TUI and socket-based CLI.

License

OpenCortex is released under the AGPLv3 license. See CLA.org for the Contributor License Agreement.