amr/passepartout
1
0
Fork 0
Code Issues 15 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

feat: add DeepSeek and NVIDIA NIM providers

Browse Source 
- Add deepseek and nvidia entries to gateway-provider config

- Add DEEPSEEK_API_KEY and NVIDIA_API_KEY to .env.example

- Add deepseek and nvidia to doctor's LLM provider check

- Fix remaining harness-log → log-message reference
This commit is contained in:
Amr Gharbeia
2026-05-02 22:25:24 -04:00
parent d803889c01
commit 95d1ea3fed
100 changed files with 5344 additions and 2743 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
USER_MANUAL.org
View File

@@ -1,61 +1,61 @@
#+TITLE: OpenCortex User Manual
#+TITLE: Passepartout User Manual
#+AUTHOR: Agent
#+STARTUP: content
#+FILETAGS: :docs:manual:
* Introduction
Welcome to the OpenCortex User Manual. This guide provides the operational knowledge required to manage your sovereign Lisp Machine and its neural skills.
Welcome to the Passepartout User Manual. This guide provides the operational knowledge required to manage your sovereign Lisp Machine and its neural skills.
* System Architecture
OpenCortex follows a "Purified Kernel" model. The core harness handles essential I/O, while all high-level logic resides in sovereign skills.
Passepartout follows a "Purified Kernel" model. The core harness handles essential I/O, while all high-level logic resides in sovereign skills.
** XDG Directory Standard
To ensure POSIX compliance, OpenCortex stores its files in standard Linux locations:
To ensure POSIX compliance, Passepartout stores its files in standard Linux locations:
| Type | Path | Purpose |
| :--- | :--- | :--- |
| **Config** | `~/.config/opencortex/` | User settings, `.env` secrets, and provider registry. |
| **Data** | `~/.local/share/opencortex/` | Tangled Lisp artifacts and the compiled engine. |
| **State** | `~/.local/state/opencortex/` | Brain snapshots, logs, and Merkle-memory. |
| **Bin** | `~/.local/bin/opencortex` | The global CLI shim. |
| **Config** | `~/.config/passepartout/` | User settings, `.env` secrets, and provider registry. |
| **Data** | `~/.local/share/passepartout/` | Tangled Lisp artifacts and the compiled engine. |
| **State** | `~/.local/state/passepartout/` | Brain snapshots, logs, and Merkle-memory. |
| **Bin** | `~/.local/bin/passepartout` | The global CLI shim. |
* Command Reference
** `opencortex setup`
** `passepartout setup`
The interactive configuration wizard. Use this to:
- Define your identity and the Agent's name.
- Register LLM providers (Ollama, Groq, Anthropic, etc.).
- The wizard automatically splits sensitive tokens into `~/.config/opencortex/.env`.
- The wizard automatically splits sensitive tokens into `~/.config/passepartout/.env`.
** `opencortex gateway link <platform> <token>`
Connects OpenCortex to external communication gateways.
- **Example:** `opencortex gateway link telegram <my_bot_token>`
- **Example:** `opencortex gateway unlink telegram` to disable
- **Example:** `opencortex gateway list` to see status
** `passepartout gateway link <platform> <token>`
Connects Passepartout to external communication gateways.
- **Example:** `passepartout gateway link telegram <my_bot_token>`
- **Example:** `passepartout gateway unlink telegram` to disable
- **Example:** `passepartout gateway list` to see status
** `opencortex doctor`
** `passepartout doctor`
Your primary diagnostic tool. Run this if the system feels sluggish or fails to boot. It verifies:
- External dependencies (sbcl, git, socat).
- XDG directory existence and permissions.
- LLM connectivity.
** `opencortex tui`
** `passepartout tui`
Launches the native Lisp Terminal User Interface.
- **Highlighting:** Semantic color-coding for Lisp and Org syntax.
- **Scrolling:** Use `PgUp`/`PgDn` to navigate history.
- **Exit:** Type `/exit` or `Ctrl+C` to close.
* Configuration Strategy
OpenCortex uses a **Hybrid Storage** model for maximum security and flexibility.
Passepartout uses a **Hybrid Storage** model for maximum security and flexibility.
** 1. Secrets (`.env`)
Found in `~/.config/opencortex/.env`. This file stores raw API tokens. It is never automatically read by the Lisp structural parser to prevent accidental leakage into logs.
Found in `~/.config/passepartout/.env`. This file stores raw API tokens. It is never automatically read by the Lisp structural parser to prevent accidental leakage into logs.
** 2. Metadata (`providers.lisp`)
Found in `~/.config/opencortex/providers.lisp`. This stores non-sensitive configuration like model names, base URLs, and user preferences as native Lisp S-expressions.
Found in `~/.config/passepartout/providers.lisp`. This stores non-sensitive configuration like model names, base URLs, and user preferences as native Lisp S-expressions.
* Troubleshooting
If `opencortex doctor` reports a `FAIL`:
If `passepartout doctor` reports a `FAIL`:
1. Check that your `PATH` includes `/usr/bin` and `/usr/local/bin`.
2. Ensure `sbcl` is installed.
3. If LLM connectivity fails, verify your API key in `~/.config/opencortex/.env`.
3. If LLM connectivity fails, verify your API key in `~/.config/passepartout/.env`.