v0.2.1: polish, deploy, CI, and literate refactor
Some checks failed
Deploy (Gitea) / deploy (push) Failing after 11s

- Secret Exposure Gate + Privacy Filter (Bouncer)
- Shell actuator safety harness (timeout, blocked patterns)
- REPL-first enforcement (lisp validation gate, system-prompt-augment)
- Engineering Standards lifecycle (two-track Org-first + REPL-first)
- Literate Programming discipline (one function per block, reflect-back)
- AGENTS.md: thin routing layer, skills are authoritative
- SKILLS_DIR removed, ~/notes fallback eliminated
- opencortex.sh: multi-distro (Debian+Fedora), configure, install service, backup, restore, help
- infrastructure/opencortex.service (systemd user unit)
- Docker: updated to debian:trixie, fixed build context
- GitHub CI: lint + test workflows fixed, trigger on tags only
- Gitea CI: deploy workflow paths fixed
- README: one-line curl install, badges
- USER_MANUAL: Deployment section (bare metal, Docker, backup)
- .gitignore: skills/*.lisp and tests/*.lisp as generated artifacts
- Prose/block refactor across all 35 org files
- Test suite Tier 1: 43/45 pass (env-dependent failures isolated)
This commit is contained in:
2026-05-02 17:04:33 -04:00
parent 9e77958028
commit 41de20d3f1
67 changed files with 1943 additions and 1287 deletions

View File

@@ -9,13 +9,26 @@ Welcome to OpenCortex v0.1.0 (The Autonomous Foundation). OpenCortex is a neuros
* Installation
OpenCortex is bootstrapped via a single shell script.
** Quick start (curl)
#+begin_src bash
git clone ssh://git@10.10.10.201:2222/amr/opencortex.git
cd opencortex
./opencortex.sh setup
curl -fsSL https://raw.githubusercontent.com/amrgharbeia/opencortex/main/opencortex.sh | bash -s configure
#+end_src
This process will install SBCL, Quicklisp, and prompt you to create a `.env` file for your API keys.
** From a clone
#+begin_src bash
git clone https://github.com/amrgharbeia/opencortex.git ~/projects/opencortex
~/projects/opencortex/opencortex.sh configure
#+end_src
Both methods will:
1. Install system dependencies (SBCL, Emacs, git, curl, socat — detected for Debian or Fedora)
2. Install Quicklisp (Common Lisp package manager)
3. Tangle literate Org sources into runnable Lisp
4. Launch the interactive setup wizard (LLM providers, gateways)
If you already have Emacs installed, the installer skips it and uses your existing installation.
* Configuration
The system is configured via a `.env` file in the project root. Essential variables include:
@@ -53,4 +66,59 @@ OpenCortex functions as your "foveal vision" inside Emacs.
OpenCortex assumes a local folder structure representing your "Memex".
- Core memories and identities are mapped to Org-mode files.
- The `Scribe` background worker distills chronological logs into structured Zettelkasten notes.
- The `Gardener` continuously repairs broken links and flags orphaned nodes.
- The `Gardener` continuously repairs broken links and flags orphaned nodes.
* Deployment
** Bare metal (Debian / Fedora)
The ~configure~ command supports both Debian-based (Ubuntu, Pop, Mint) and Fedora-based (RHEL, Rocky) distributions. It detects your distro automatically and installs the correct packages.
#+begin_src bash
./opencortex.sh configure # interactive
./opencortex.sh configure --non-interactive # headless
./opencortex.sh configure --with-firewall # also open port 9105
#+end_src
After configuration, you can re-run ~configure~ any time to add providers or link gateways.
** systemd service (auto-start on boot)
#+begin_src bash
./opencortex.sh install service
#+end_src
Installs a user-level systemd unit that starts the daemon on login. Logs are available via ~journalctl --user -u opencortex.service -f~.
To remove:
#+begin_src bash
./opencortex.sh uninstall service
#+end_src
** Docker
A Debian-based Docker image is provided for containerized deployment.
#+begin_src bash
cd infrastructure/docker
docker-compose up -d
#+end_src
This builds an image from ~debian:trixie-slim~ with all dependencies pre-installed. The memex directory is mounted from the host.
** Backup
#+begin_src bash
./opencortex.sh backup ~/my-backup.tar.gz
#+end_src
Backs up the config, data, and memex directories.
** Restore
#+begin_src bash
./opencortex.sh restore ~/my-backup.tar.gz
#+end_src
Restores from a backup file. Run ~opencortex doctor~ afterward to verify integrity.