Home

Home.md

@@ -0,0 +1,54 @@
+# LLeMbas CLI — developer wiki
+
+LLeMbas CLI is a terminal coding agent and project manager: the `lembas`
+command. TypeScript on Bun, rendered with OpenTUI and Solid, shipped as one
+compiled, signed binary for Linux (x64, x64 without AVX2, arm64). It talks to any
+LLM API through a native client per dialect, works in a project under four
+permission modes with a git snapshot of every turn, keeps memory, skills and
+knowledge bases, speaks MCP, and can sign in to a
+[LLeMbas](https://github.com/LLeMbas/LLeMbas) server to use its models, library and
+search — and let its web UI work the same sessions.
+
+**This wiki is for people changing the code.** User documentation lives on the
+website:
+
+| Looking for | Go to |
+|---|---|
+| Installing and using the CLI | <https://llembas.eu/cli.html> and <https://llembas.eu/docs/> |
+| Every configuration key | <https://llembas.eu/docs/cli-configuration.html> |
+| What changed in each release | <https://llembas.eu/changelog.html> and `CHANGELOG.md` |
+| Verifying a release by hand, reporting a vulnerability | `SECURITY.md` in the repository |
+| The server | [LLeMbas](https://github.com/LLeMbas/LLeMbas) |
+
+## Pages
+
+| Page | What it covers |
+|---|---|
+| [Working notes](Working-notes) | **Read first.** The rules the project is built on and why, building, testing and releasing, and the lessons from bugs that shipped looking correct — kept as rules. |
+| [Architecture](Architecture) | The layout of `src/`: the app wiring, the engine loop, providers, tools, permissions, the session store, the TUI, the ACP agent, hub, share and link, updates and signing, the service. |
+| [Harness parity](Harness-parity) | The harness design shared with LLeMbas: every concept mapped to its file in both projects, and where they still differ. |
+| [Configuration](Configuration) | For developers: how configuration is loaded, layered, trusted and validated, and what to touch when adding a key. |
+
+## Where it comes from
+
+It takes its project system, permission rules, patch and edit matching, question
+tool and autocomplete from [OpenCode](https://github.com/anomalyco/opencode), its
+renderer from [OpenTUI](https://github.com/anomalyco/opentui), its memory,
+skills, MCP client, threat patterns, voice and look from
+[Hermes Agent](https://github.com/NousResearch/hermes-agent), and its connection
+knobs, model quirks, chunker, reasoning splitter and prompt texts from LLeMbas.
+Every lifted file says so in its header; `THIRD_PARTY.md` lists the licences.
+
+## Getting going
+
+```sh
+bun install
+bun run dev                  # the TUI from source
+bun test                     # unit and end-to-end tests against a scripted fake endpoint
+bunx tsc --noEmit
+bun run smoke                # build dist/lembas and drive the compiled binary
+scripts/ci.sh                # everything a release has to pass
+```
+
+Running the TUI from source outside the repository needs
+`bun --config=<repo>/bunfig.toml`, or the Solid JSX preload is not loaded.