summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2026-03-21 12:58:43 +0200
committerPaul Buetow <paul@buetow.org>2026-03-21 12:58:43 +0200
commit90b17120e986d45e830afedc4c9bba60f3dab16c (patch)
treec8fc50619617a8a4909cc59f864b7250b680a138
parent437168c7a47ee656edc91177b9753957b9361209 (diff)
Add 'Why Pi' section to README.md
Concise bullet-point summary of Pi's key differentiators for this setup: bring-your-own-model OpenAI API, custom providers via models.json, project-local config via ~/.pi symlink, TypeScript extensions, and minimal core design. Placed after the Architecture topology notes and before Prerequisites.
-rw-r--r--README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/README.md b/README.md
index a018ab1..7ccc620 100644
--- a/README.md
+++ b/README.md
@@ -39,6 +39,14 @@ Runs two A100 VMs concurrently — each serving a different model — with [Pi](
- vLLM on each VM listens on `0.0.0.0:11434`, firewalled to `192.168.3.0/24` (WireGuard subnet only)
- Pi connects directly to each VM's vLLM over the tunnel — no proxy or load balancer
+## Why Pi
+
+- **Bring-your-own model** — connects to any OpenAI-compatible endpoint; no translation proxy needed between Pi and vLLM
+- **Custom providers via `models.json`** — define `hyperstack`, `hyperstack1`, and `hyperstack2` providers once; fish abbreviations route to the right VM
+- **Project-local config** — symlink this repo's `pi/` directory to `~/.pi`; Pi picks up `models.json`, `settings.json`, extensions, and skills automatically
+- **TypeScript extensions** — custom behaviour (web search, loop scheduler, ask-mode) lives in `pi/agent/extensions/` and loads from the symlink
+- **Minimal core** — no built-in sub-agents, plan mode, or permission popups; fast TUI with mid-session model switching via `Ctrl+L`
+
## Prerequisites
- Hyperstack account with API key in `~/.hyperstack`