Skip to content

Commit bf73a1d

Browse files
authored
docs(embed): document control center commands (#2151)
1 parent ca2ce5c commit bf73a1d

2 files changed

Lines changed: 92 additions & 0 deletions

File tree

hindsight-docs/docs/sdks/embed.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,35 @@ hindsight-embed memory reflect default "What color scheme should I use?"
8282

8383
The daemon starts automatically on first use!
8484

85+
### 3. Open the Control Center (optional)
86+
87+
Use the local control center when you want a browser-based configuration wizard and daemon supervisor:
88+
89+
```bash
90+
# Launch the control center and open the browser
91+
hindsight-embed control start
92+
93+
# Or use the browser wizard instead of terminal prompts during setup
94+
hindsight-embed configure --ui
95+
```
96+
97+
The control center listens on localhost only (`http://localhost:7878` by default) and prints a tokenized URL. It stores the local access token at `~/.hindsight/control.token` and writes logs to `~/.hindsight/control.log`.
98+
99+
```bash
100+
# Pick a different control-center port for this launch
101+
hindsight-embed control start --port 7879
102+
103+
# Start without opening a browser automatically
104+
hindsight-embed control start --no-open
105+
106+
# Check, inspect, or stop the control center
107+
hindsight-embed control status
108+
hindsight-embed control logs -f
109+
hindsight-embed control stop
110+
```
111+
112+
The control center runs as a separate process from the memory daemon. Stopping or restarting the control center does not stop a running daemon.
113+
85114
## Environment Variables
86115

87116
| Variable | Description | Default |
@@ -90,6 +119,7 @@ The daemon starts automatically on first use!
90119
| `HINDSIGHT_API_LLM_PROVIDER` | LLM provider: `openai`, `anthropic`, `gemini`, `groq`, `minimax`, `ollama` | `openai` |
91120
| `HINDSIGHT_API_LLM_MODEL` | Model name | `gpt-4o-mini` |
92121
| `HINDSIGHT_EMBED_DAEMON_IDLE_TIMEOUT` | Seconds before daemon auto-exits when idle (0 = never) | `0` |
122+
| `HINDSIGHT_EMBED_CONTROL_PORT` | Default port for `hindsight-embed control start` | `7878` |
93123

94124
**Provider Examples:**
95125

@@ -140,6 +170,22 @@ hindsight-embed daemon logs -f
140170
hindsight-embed daemon stop
141171
```
142172

173+
### Control Center Commands
174+
175+
```bash
176+
# Start or reuse the local browser control center
177+
hindsight-embed control start
178+
179+
# Check whether it is running
180+
hindsight-embed control status
181+
182+
# View control-center logs
183+
hindsight-embed control logs -f
184+
185+
# Stop the control-center process
186+
hindsight-embed control stop
187+
```
188+
143189
## Commands
144190

145191
All memory operations follow the same interface as the CLI:

skills/hindsight-docs/references/sdks/embed.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,35 @@ hindsight-embed memory reflect default "What color scheme should I use?"
8282

8383
The daemon starts automatically on first use!
8484

85+
### 3. Open the Control Center (optional)
86+
87+
Use the local control center when you want a browser-based configuration wizard and daemon supervisor:
88+
89+
```bash
90+
# Launch the control center and open the browser
91+
hindsight-embed control start
92+
93+
# Or use the browser wizard instead of terminal prompts during setup
94+
hindsight-embed configure --ui
95+
```
96+
97+
The control center listens on localhost only (`http://localhost:7878` by default) and prints a tokenized URL. It stores the local access token at `~/.hindsight/control.token` and writes logs to `~/.hindsight/control.log`.
98+
99+
```bash
100+
# Pick a different control-center port for this launch
101+
hindsight-embed control start --port 7879
102+
103+
# Start without opening a browser automatically
104+
hindsight-embed control start --no-open
105+
106+
# Check, inspect, or stop the control center
107+
hindsight-embed control status
108+
hindsight-embed control logs -f
109+
hindsight-embed control stop
110+
```
111+
112+
The control center runs as a separate process from the memory daemon. Stopping or restarting the control center does not stop a running daemon.
113+
85114
## Environment Variables
86115

87116
| Variable | Description | Default |
@@ -90,6 +119,7 @@ The daemon starts automatically on first use!
90119
| `HINDSIGHT_API_LLM_PROVIDER` | LLM provider: `openai`, `anthropic`, `gemini`, `groq`, `minimax`, `ollama` | `openai` |
91120
| `HINDSIGHT_API_LLM_MODEL` | Model name | `gpt-4o-mini` |
92121
| `HINDSIGHT_EMBED_DAEMON_IDLE_TIMEOUT` | Seconds before daemon auto-exits when idle (0 = never) | `0` |
122+
| `HINDSIGHT_EMBED_CONTROL_PORT` | Default port for `hindsight-embed control start` | `7878` |
93123

94124
**Provider Examples:**
95125

@@ -140,6 +170,22 @@ hindsight-embed daemon logs -f
140170
hindsight-embed daemon stop
141171
```
142172

173+
### Control Center Commands
174+
175+
```bash
176+
# Start or reuse the local browser control center
177+
hindsight-embed control start
178+
179+
# Check whether it is running
180+
hindsight-embed control status
181+
182+
# View control-center logs
183+
hindsight-embed control logs -f
184+
185+
# Stop the control-center process
186+
hindsight-embed control stop
187+
```
188+
143189
## Commands
144190

145191
All memory operations follow the same interface as the CLI:

0 commit comments

Comments
 (0)