docs: clarify headless json output format

Explain that `--format json` now emits semantic JSON events so the README matches the current headless behavior.
This commit is contained in:
Ismail Pelaseyed committed 2026-03-22 20:18:29 +01:00
1 parent 58cbc9c129
commit 5245dcef1a
1 file changed
+3 -2
+3 -2
View File
@@ -64,8 +64,9 @@ Works in interactive mode too—same flag.
grok --prompt "summarize the repo state" --format json
```
`--format json` emits newline-delimited `StreamChunk` objects instead of the
default human-readable text stream.
`--format json` emits a newline-delimited JSON event stream instead of the
default human-readable text output. Events are semantic, step-level records such
as `step_start`, `text`, `tool_use`, `step_finish`, and `error`.
**List Grok models and pricing hints:**