Skip to content

Commit e9581f0

Browse files
Kasper JungeRalphify
authored andcommitted
docs: add live output streaming troubleshooting for users who can't see agent output
Co-authored-by: Ralphify <noreply@ralphify.co>
1 parent e1233ab commit e9581f0

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/troubleshooting.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,15 @@ Common causes:
111111
- There's no concrete task source — point the prompt at something like `TODO.md`, `PLAN.md`, or failing tests
112112
- The agent can't find what it's supposed to work on
113113

114+
### Agent output not streaming to the terminal
115+
116+
In an interactive terminal, agent output streams live by default. If you don't see any output between the iteration markers:
117+
118+
- **Check the peek toggle** — press `p` to toggle live output on or off. You may have silenced it in a previous iteration.
119+
- **Non-TTY environments** — live streaming is disabled when output is piped, redirected, or running in CI. This is intentional — use `--log-dir` to capture output instead.
120+
- **Output appears in bursts** — some runtimes block-buffer stdout when piped. Set `PYTHONUNBUFFERED=1` in your environment to force line-buffered output.
121+
- **Full-screen TUI agents** — agents that repaint their own terminal (curses-based tools) are not supported for live streaming. They detect a non-TTY and fall back to plain output, which may be minimal.
122+
114123
## Frontmatter issues
115124

116125
### "Invalid YAML in frontmatter"
@@ -447,7 +456,7 @@ If a `{{ commands.my-command }}` placeholder produces nothing in the prompt:
447456
3. Must be `commands` (plural) — `{{ command.name }}` won't resolve
448457

449458
??? note "No output visible during iteration"
450-
By default, agent output goes directly to the terminal. If you're using `--log-dir`, output is captured and then replayed — you'll still see it, but only after the iteration completes.
459+
Agent output streams live to the terminal by default — press `p` to toggle it on or off. If you're using `--log-dir`, output is also echoed after each iteration completes. See [Agent output not streaming](#agent-output-not-streaming-to-the-terminal) for more details.
451460

452461
??? note "CLI flag validation errors"
453462
### "'-n' must be a positive integer"

0 commit comments

Comments
 (0)