Amr Gharbeia
a717ab1d3a
Some checks failed
Deploy-Agent-V15-Stdin / JOB-V15-STDIN (push) Failing after 2s
63 lines
2.5 KiB
Org Mode
63 lines
2.5 KiB
Org Mode
#+TITLE: OpenCortex: Your Autonomous, Plain-Text Life Assistant
|
|
#+AUTHOR: Amr
|
|
#+FILETAGS: :opencortex:ai:assistant:
|
|
|
|
* 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).
|
|
|
|
#+begin_src bash
|
|
# 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
|
|
#+end_src
|
|
|
|
* 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.
|
|
|
|
- **[[file:USER_MANUAL.org][User Manual]]**: Detailed guide on configuration, XDG paths, and commands.
|
|
- **[[file:docs/ROADMAP.org][The Evolutionary Roadmap]]**: Long-term vision and milestone progress.
|
|
- **[[file:docs/CONTRIBUTING.org][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 [[file:LICENSE][AGPLv3 license]].
|
|
See [[file:CLA.org][CLA.org]] for the Contributor License Agreement.
|