Skip to content

Commit 5269d7e

Browse files
committed
docs: document supervised TUI Logs streaming
Document real-time log streaming behavior in supervised TUI and add an Unreleased changelog entry. Note that stdout/stderr forwarding can be disabled via ROBOPPI_TUI_STREAM_STDIO=0.
1 parent 9927053 commit 5269d7e

7 files changed

Lines changed: 44 additions & 0 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
44

55
The format is based on Keep a Changelog, and this project follows SemVer where practical.
66

7+
## [Unreleased]
8+
9+
### Added
10+
11+
- Supervised workflow TUI now streams worker events to `2: Logs` in real time (stdout/stderr/progress/patch) via IPC `job_event` messages.
12+
13+
### Changed
14+
15+
- In supervised + TUI mode, stdout/stderr forwarding to `2: Logs` is enabled by default; set `ROBOPPI_TUI_STREAM_STDIO=0` to forward progress/patch only.
16+
717
## [0.1.5] - 2026-02-25
818

919
### Added

‎README.ja.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,11 @@ JSON Lines IPC サーバーを起動します(stdin を読み、stdout に応
9999
workflow runner で実行します。デフォルトは supervised 実行(Core IPC 経由)です。
100100
Core を介さず runner が直接 worker を spawn する場合は `--direct` を使います。
101101

102+
TUI について:
103+
104+
- stderr が TTY のとき TUI は自動で有効です(無効化: `--no-tui`)。
105+
- supervised + TUI では `2: Logs` に worker のリアルタイム出力(stdout/stderr/progress/patch)が表示されます。stdout/stderr を転送したくない場合は `ROBOPPI_TUI_STREAM_STDIO=0` を設定してください。
106+
102107
```bash
103108
./roboppi workflow examples/hello-world.yaml --verbose
104109
# (dev) bun run src/workflow/run.ts examples/hello-world.yaml --verbose

‎README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,11 @@ Workflows are executed by the workflow runner.
107107
By default, workflows run in supervised mode (Supervisor -> Core -> Worker).
108108
Use `--direct` to spawn workers directly from the runner (no Core IPC).
109109

110+
TUI notes:
111+
112+
- TUI is enabled by default when stderr is a TTY (disable with `--no-tui`).
113+
- In supervised + TUI mode, `2: Logs` shows real-time worker output (stdout/stderr/progress/patch). To disable stdout/stderr forwarding, set `ROBOPPI_TUI_STREAM_STDIO=0`.
114+
110115
```bash
111116
ROBOPPI_VERBOSE=1 bun run src/workflow/run.ts examples/agent-pr-loop.yaml \
112117
--workspace /tmp/my-work --verbose

‎docs/guide/quickstart.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -401,6 +401,11 @@ roboppi workflow my-workflow.yaml --verbose
401401
# (dev) bun run src/workflow/run.ts my-workflow.yaml --verbose
402402
```
403403

404+
TUI notes:
405+
406+
- TUI is enabled by default when stderr is a TTY (disable with `--no-tui`).
407+
- In supervised + TUI mode, `2: Logs` shows real-time worker output (stdout/stderr/progress/patch). To disable stdout/stderr forwarding, set `ROBOPPI_TUI_STREAM_STDIO=0`.
408+
404409
For each step, Roboppi Core requests a Permit, delegates to the worker, and collects results. If a step fails, it aborts depending on policy.
405410

406411
### Reuse worker settings with agent catalogs

‎docs/guide/workflow.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -579,13 +579,22 @@ Use `--direct` to spawn worker processes directly from the runner (no Core IPC).
579579
| `--supervised` | - | supervised mode: delegate steps via Core IPC (Supervisor -> Core -> Worker) | on |
580580
| `--direct` | - | direct mode: spawn worker processes directly (no Core IPC) | off |
581581
| `--no-supervised` | - | alias for `--direct` | - |
582+
| `--tui` | - | force-enable the interactive workflow TUI (renders to stderr) | auto |
583+
| `--no-tui` | - | disable the TUI (plain output) | auto |
582584
| `--keepalive` | - | emit periodic output to avoid no-output watchdogs | auto (on when non-TTY) |
583585
| `--no-keepalive` | - | disable keepalive output | - |
584586
| `--keepalive-interval <d>` | - | keepalive interval (DurationString) | `10s` |
585587
| `--ipc-request-timeout <d>` | - | IPC request timeout for supervised mode (DurationString) | `2m` |
586588
| `--agents <path>` | - | agent catalog YAML (repeatable); merged with `ROBOPPI_AGENTS_FILE` | auto-load `agents.yaml` / `agents.yml` next to workflow |
587589
| `--help` | `-h` | show help | - |
588590

591+
### TUI logs streaming (supervised)
592+
593+
When running in supervised mode with TUI enabled, the `2: Logs` tab shows real-time worker output (stdout/stderr/progress/patch).
594+
595+
- Default: stdout/stderr are forwarded.
596+
- Opt-out: set `ROBOPPI_TUI_STREAM_STDIO=0` to forward progress/patch only.
597+
589598
### Examples
590599

591600
```bash

‎docs/quickstart.ja.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,11 @@ bun run --cwd "$AGENTCORE_ROOT" src/workflow/run.ts \
211211
--supervised --verbose
212212
```
213213

214+
TUI について:
215+
216+
- stderr が TTY のとき TUI は自動で有効です(無効化: `--no-tui`)。
217+
- supervised + TUI では `2: Logs` に worker のリアルタイム出力(stdout/stderr/progress/patch)が表示されます。stdout/stderr を転送したくない場合は `ROBOPPI_TUI_STREAM_STDIO=0` を設定してください。
218+
214219
### 引数の説明
215220

216221
| 引数 | 説明 |

‎docs/quickstart.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,11 @@ bun run --cwd "$AGENTCORE_ROOT" src/workflow/run.ts \
212212
--supervised --verbose
213213
```
214214

215+
TUI notes:
216+
217+
- TUI is enabled by default when stderr is a TTY (disable with `--no-tui`).
218+
- In supervised + TUI mode, `2: Logs` shows real-time worker output (stdout/stderr/progress/patch). To disable stdout/stderr forwarding, set `ROBOPPI_TUI_STREAM_STDIO=0`.
219+
215220
### Arguments
216221

217222
| Argument | Description |

0 commit comments

Comments
 (0)