Skip to content

Commit 70ccc6e

Browse files
authored
docs(readme): clarify desktop setup (#4)
1 parent 629c99f commit 70ccc6e

1 file changed

Lines changed: 42 additions & 5 deletions

File tree

README.md

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,16 +99,38 @@ append-only and audited.
9999

100100
## Quick Start
101101

102-
**1. Start infrastructure**
102+
**1. Activate the pinned toolchain**
103+
104+
```bash
105+
. ./bin/activate-hermit
106+
```
107+
108+
Hermit pins Rust, Node.js, pnpm, `just`, and related tooling from `bin/`.
109+
If you prefer not to use Hermit, install the prerequisites manually first.
110+
111+
**2. Start infrastructure**
103112

104113
```bash
105114
cp .env.example .env
106-
docker compose up -d
115+
just setup
107116
```
108117

118+
`just setup` starts Docker services and applies pending database migrations.
119+
109120
Services: MySQL `:3306`, Redis `:6379`, Typesense `:8108`, Adminer `:8082`
110121

111-
**2. Start the relay**
122+
**3. Install desktop dependencies**
123+
124+
```bash
125+
just desktop-install
126+
```
127+
128+
This is required before running `just check`, `just ci`, Git hooks, or any
129+
`just desktop-*` command.
130+
131+
The desktop workflow documented here is macOS-first for now.
132+
133+
**4. Start the relay**
112134

113135
```bash
114136
just relay
@@ -117,7 +139,7 @@ just relay
117139

118140
Relay listens on `ws://localhost:3000` by default.
119141

120-
**3. Mint an API token**
142+
**5. Mint an API token**
121143

122144
```bash
123145
cargo run -p sprout-admin -- mint-token \
@@ -127,7 +149,7 @@ cargo run -p sprout-admin -- mint-token \
127149

128150
Outputs a bearer token. Set it as `SPROUT_API_TOKEN` for the MCP server.
129151

130-
**4. Connect an agent via MCP**
152+
**6. Connect an agent via MCP**
131153

132154
```bash
133155
SPROUT_RELAY_URL=ws://localhost:3000 \
@@ -137,6 +159,13 @@ cargo run -p sprout-mcp
137159

138160
The MCP server speaks stdio JSON-RPC. Wire it into any MCP-compatible agent host.
139161

162+
**7. Run the desktop app (optional)**
163+
164+
```bash
165+
just desktop-app
166+
# or: just desktop-dev
167+
```
168+
140169
## Configuration
141170

142171
Copy `.env.example` to `.env`. All defaults work with `docker compose up` out of the box.
@@ -201,6 +230,14 @@ This repo uses [Hermit](https://cashapp.github.io/hermit/) for toolchain pinning
201230
. ./bin/activate-hermit
202231
```
203232

233+
For a fresh clone, install desktop dependencies before running desktop-aware
234+
checks or hooks:
235+
236+
```bash
237+
just desktop-install
238+
lefthook install
239+
```
240+
204241
**Common tasks**
205242

206243
```bash

0 commit comments

Comments
 (0)