Skip to content

Commit fba5f3e

Browse files
docs: rewrite README with badges, features, download table, and quick-start
1 parent 7379c35 commit fba5f3e

1 file changed

Lines changed: 84 additions & 37 deletions

File tree

README.md

Lines changed: 84 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,64 @@
1-
# Honcho UI
2-
3-
A clean, fast frontend for browsing and chatting with a self-hosted [Honcho](https://github.com/plastic-labs/honcho) instance.
4-
5-
> **Privacy-first**: all connection details (base URL, optional token) are stored locally in your browser — never sent anywhere except directly to your Honcho instance.
1+
<div align="center">
2+
<img src="packages/web/public/favicon.svg" width="96" height="96" alt="OpenConcho" />
3+
<h1>OpenConcho</h1>
4+
<p>A fast, privacy-first desktop &amp; web UI for self-hosted <a href="https://github.com/plastic-labs/honcho">Honcho</a> instances.</p>
5+
6+
<p>
7+
<a href="https://github.com/offendingcommit/openconcho/actions/workflows/ci.yml">
8+
<img src="https://github.com/offendingcommit/openconcho/actions/workflows/ci.yml/badge.svg" alt="CI" />
9+
</a>
10+
<a href="https://github.com/offendingcommit/openconcho/releases/latest">
11+
<img src="https://img.shields.io/github/v/release/offendingcommit/openconcho" alt="Latest release" />
12+
</a>
13+
<a href="https://github.com/offendingcommit/openconcho/releases/latest">
14+
<img src="https://img.shields.io/github/downloads/offendingcommit/openconcho/total" alt="Downloads" />
15+
</a>
16+
<img src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux%20%7C%20Windows-blue" alt="Platforms" />
17+
<a href="LICENSE">
18+
<img src="https://img.shields.io/github/license/offendingcommit/openconcho" alt="License" />
19+
</a>
20+
</p>
21+
</div>
622

723
---
824

25+
Browse memories, peers, sessions, and conclusions — or chat with full memory context — directly against your own Honcho instance. All connection details stay in your browser; nothing leaves except requests to the URL you configure.
26+
927
## Features
1028

11-
- **Dashboard** — workspace count and queue status at a glance, auto-refreshes every 10 s
12-
- **Workspaces** — paginated list with per-workspace navigation
13-
- **Peers** — browse peers, view representations, context, and peer cards
14-
- **Sessions** — paginated message history with summaries and context
15-
- **Conclusions** — semantic search across conclusions with observer/subject display
16-
- **Chat** — conversational interface that sends messages through Honcho's chat endpoint with memory context
17-
- **Dark / light mode** — persisted per browser, instant toggle
18-
- **Optional auth** — token field is optional; a connection health check auto-detects whether auth is required
29+
| | |
30+
|---|---|
31+
| **Dashboard** | Workspace count and queue status, auto-refreshes every 10 s |
32+
| **Workspaces** | Paginated list with per-workspace navigation |
33+
| **Peers** | Browse peers, view representations, context, and peer cards |
34+
| **Sessions** | Paginated message history with summaries and context |
35+
| **Conclusions** | Semantic search across conclusions with observer/subject display |
36+
| **Webhooks** | Manage and trigger webhooks per workspace |
37+
| **Chat** | Conversational interface through Honcho's chat endpoint with memory context |
38+
| **Schedule Dream** | Trigger Honcho's dream/consolidation pass on demand |
39+
| **Dark / light mode** | Persisted per device, instant toggle |
40+
| **Optional auth** | Token field is optional; connection health check auto-detects auth requirement |
41+
42+
## Download
43+
44+
Pre-built binaries are attached to every [GitHub Release](https://github.com/offendingcommit/openconcho/releases/latest):
45+
46+
| Platform | File |
47+
|---|---|
48+
| macOS (Apple Silicon) | `OpenConcho_*_aarch64.dmg` |
49+
| macOS (Intel) | `OpenConcho_*_x64.dmg` |
50+
| Linux | `openconcho_*_amd64.deb` / `openconcho_*_amd64.AppImage` |
51+
| Windows | `OpenConcho_*_x64-setup.exe` / `OpenConcho_*_x64_en-US.msi` |
1952

2053
## Quick Start
2154

2255
### Prerequisites
2356

24-
- Node.js ≥ 20
25-
- pnpm ≥ 9
26-
- A running Honcho instance (local or remote)
57+
- [Node.js](https://nodejs.org/) ≥ 20
58+
- [pnpm](https://pnpm.io/) ≥ 9
59+
- A running [Honcho](https://github.com/plastic-labs/honcho) instance (local or remote)
2760

28-
### Install & run
61+
### Web app
2962

3063
```bash
3164
git clone https://github.com/offendingcommit/openconcho.git
@@ -34,63 +67,77 @@ pnpm install
3467
pnpm dev
3568
```
3669

37-
Open http://localhost:5173 — you'll be prompted to enter your Honcho URL.
70+
Open http://localhost:5173 and enter your Honcho URL when prompted.
71+
72+
### Desktop app (Tauri)
73+
74+
Additional prerequisites: [Rust](https://rustup.rs/) stable + [Tauri system dependencies](https://v2.tauri.app/start/prerequisites/) for your OS.
75+
76+
```bash
77+
git clone https://github.com/offendingcommit/openconcho.git
78+
cd openconcho
79+
pnpm install
80+
pnpm --filter @openconcho/desktop dev
81+
```
3882

39-
### Connect to your instance
83+
### Connecting to your instance
4084

4185
1. Enter the base URL of your Honcho instance (e.g. `http://localhost:8000`)
4286
2. Optionally enter an API token if your instance requires auth
43-
3. Click **Test connection** — the UI will tell you if auth is needed
87+
3. Click **Test connection** — the UI reports whether auth is needed
4488
4. Click **Save** — you're in
4589

46-
### Build for production
90+
### Production build
4791

4892
```bash
49-
pnpm build
50-
# Output in dist/ — serve with any static host
93+
pnpm build # web only → packages/web/dist/
94+
pnpm --filter @openconcho/desktop build # desktop → packages/desktop/src-tauri/target/release/bundle/
5195
```
5296

5397
## Stack
5498

5599
| Layer | Library |
56-
|-------|---------|
100+
|---|---|
101+
| Desktop shell | [Tauri v2](https://v2.tauri.app/) |
57102
| Framework | React 19 + Vite 8 |
58103
| Routing | TanStack Router v1 (file-based) |
59104
| Data fetching | TanStack Query v5 |
60105
| API client | openapi-fetch (typed from `openapi.json`) |
61106
| Styling | Tailwind CSS v4 + CSS custom properties |
62107
| Animation | framer-motion |
63108
| Icons | lucide-react |
64-
| Lint / format | Biome |
65-
| Tests | Vitest + Testing Library |
109+
| Lint / format | Biome 2 |
110+
| Tests | Vitest 4 + Testing Library |
111+
| Releases | semantic-release (conventional commits) |
66112

67113
## Development
68114

69115
```bash
70-
pnpm dev # dev server with HMR
71-
pnpm lint:fix # Biome lint + format
72-
pnpm test # run tests
73-
pnpm generate:api # regenerate src/api/schema.d.ts from openapi.json
116+
pnpm dev # Vite dev server (web, http://localhost:5173)
117+
pnpm test # Vitest test suite
118+
pnpm lint:fix # Biome lint + format
119+
pnpm typecheck # TypeScript strict check
120+
pnpm generate:api # Regenerate src/api/schema.d.ts from openapi.json
74121
```
75122

76-
## Regenerating API types
123+
### Regenerating API types
77124

78-
If your Honcho instance is updated, grab a fresh `openapi.json` and run:
125+
When your Honcho instance is updated, pull a fresh schema and regenerate:
79126

80127
```bash
81-
curl http://your-honcho-url/openapi.json -o openapi.json
82-
pnpm generate:api
128+
curl http://your-honcho-url/openapi.json -o packages/web/openapi.json
129+
pnpm --filter @openconcho/web generate:api
83130
```
84131

85132
## Privacy
86133

87-
- Base URL and token are stored in `localStorage` under `openconcho:config`
88-
- Theme preference is stored in `localStorage` under `openconcho:theme`
134+
- Base URL and token stored in `localStorage` under `openconcho:config`
135+
- Theme preference stored in `localStorage` under `openconcho:theme`
89136
- No telemetry, no analytics, no external requests beyond your configured Honcho instance
90137

91138
## Contributing
92139

93-
Issues and PRs welcome. Open an issue first for significant changes.
140+
Open an issue first for significant changes. PRs welcome.
94141

95142
## License
96143

0 commit comments

Comments
 (0)