Skip to content

Commit 8f8a64c

Browse files
Merge pull request #48 from offendingcommit/docs/refresh-agents-readme
docs: refresh AGENTS.md + README for v0.13.0 accuracy
2 parents e3190c0 + ad2d131 commit 8f8a64c

2 files changed

Lines changed: 30 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,8 @@ Before pushing any change under `packages/desktop/**` or `packages/desktop/src-t
6363

6464
## Key Constraints
6565

66-
- **No hardcoded URLs** — all connection config lives in `localStorage` under `openconcho:config`
66+
- **No hardcoded URLs** — connection config lives in `localStorage` under `openconcho:instances` (multi-instance store; legacy `openconcho:config` is auto-migrated)
67+
- **Local git hooks**`.husky/pre-commit` runs a secret scan + Biome on staged files; `.husky/pre-push` runs `pnpm check`. Your commits and pushes trigger these.
6768
- **TanStack Router flat-route params** — always cast `params` as `as never` at `navigate()` and `<Link>` callsites
6869
- **`framer-motion` Variants typing** — import `type Variants` and annotate objects; never use `as const` on variant objects
6970
- **Auth is optional** — token header only sent when non-empty; `checkConnection()` detects if auth is required

README.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,20 @@ Browse memories, peers, sessions, and conclusions — or chat with full memory c
2929
| | |
3030
|---|---|
3131
| **Dashboard** | Workspace count and queue status, auto-refreshes every 10 s |
32+
| **Multiple instances** | Add and switch between several Honcho connections |
33+
| **Fleet dashboard** | Cross-instance observability — workspaces/sessions/queue side-by-side with per-instance badges |
3234
| **Workspaces** | Paginated list with per-workspace navigation |
3335
| **Peers** | Browse peers, view representations, context, and peer cards |
36+
| **Peer display names** | Set a friendly `display_name` (metadata) to replace raw peer ids |
37+
| **Peer Card Seed Kits** | Author reusable peer-card kits and apply them across instances |
3438
| **Sessions** | Paginated message history with summaries and context |
3539
| **Conclusions** | Semantic search across conclusions with observer/subject display |
40+
| **Dream viewer** | Browse dream/consolidation bursts with a recursive premise tree |
41+
| **Dialectic playground** | Fan one query across all reasoning levels side-by-side |
3642
| **Webhooks** | Manage and trigger webhooks per workspace |
3743
| **Chat** | Conversational interface through Honcho's chat endpoint with memory context |
3844
| **Schedule Dream** | Trigger Honcho's dream/consolidation pass on demand |
45+
| **Demo mode** | Mask identifiers/content for screenshots and screen-sharing |
3946
| **Dark / light mode** | Persisted per device, instant toggle |
4047
| **Optional auth** | Token field is optional; connection health check auto-detects auth requirement |
4148

@@ -47,15 +54,15 @@ Pre-built binaries are attached to every [GitHub Release](https://github.com/off
4754
|---|---|
4855
| macOS (Apple Silicon) | `OpenConcho_*_aarch64.dmg` |
4956
| macOS (Intel) | `OpenConcho_*_x64.dmg` |
50-
| Linux | `openconcho_*_amd64.deb` / `openconcho_*_amd64.AppImage` |
57+
| Linux | `openconcho_*_amd64.deb` / `openconcho_*_amd64.AppImage` / `OpenConcho-*.x86_64.rpm` |
5158
| Windows | `OpenConcho_*_x64-setup.exe` / `OpenConcho_*_x64_en-US.msi` |
5259

5360
## Quick Start
5461

5562
### Prerequisites
5663

57-
- [Node.js](https://nodejs.org/)20
58-
- [pnpm](https://pnpm.io/) ≥ 9
64+
- [Node.js](https://nodejs.org/)22
65+
- [pnpm](https://pnpm.io/) 10 (pinned via `packageManager`; `corepack enable` picks it up)
5966
- A running [Honcho](https://github.com/plastic-labs/honcho) instance (local or remote)
6067

6168
### Web app
@@ -80,6 +87,23 @@ pnpm install
8087
pnpm --filter @openconcho/desktop dev
8188
```
8289

90+
### Docker (web app)
91+
92+
Run the web UI in a container — handy for adding it to a self-hosted Honcho
93+
Compose stack. The image serves the SPA and reverse-proxies the Honcho API under
94+
its own origin, so the browser makes same-origin requests (no CORS to configure).
95+
96+
```bash
97+
docker run --rm -p 8080:8080 \
98+
-e HONCHO_UPSTREAM=http://host.docker.internal:8000 \
99+
ghcr.io/offendingcommit/openconcho-web:latest
100+
# → http://localhost:8080
101+
```
102+
103+
To drop it into a Honcho Compose stack, use the `openconcho` service in
104+
[`docker-compose.yml`](docker-compose.yml). Full details, env vars, and the CORS
105+
options are in [`docs/docker.md`](docs/docker.md).
106+
83107
### Connecting to your instance
84108

85109
1. Enter the base URL of your Honcho instance (e.g. `http://localhost:8000`)
@@ -131,7 +155,7 @@ pnpm --filter @openconcho/web generate:api
131155

132156
## Privacy
133157

134-
- Base URL and token stored in `localStorage` under `openconcho:config`
158+
- Connection details (base URL + token, one or more instances) stored in `localStorage` under `openconcho:instances`
135159
- Theme preference stored in `localStorage` under `openconcho:theme`
136160
- No telemetry, no analytics, no external requests beyond your configured Honcho instance
137161

0 commit comments

Comments
 (0)